diff --git a/HACKING b/HACKING index 3453432..78fd65d 100644 --- a/HACKING +++ b/HACKING @@ -7,7 +7,6 @@ This file is in the public domain. Coding style ------------ - Let's now describe a bit the C++ coding style in this project. (this is just a proposal for now, please modify.) @@ -30,7 +29,6 @@ Let's now describe a bit the C++ coding style in this project. Version Number -------------- - It is made of major.minor.micro numbers. Releases with an odd minor version number are in an unstable branch, whose API and command line argument might change. (sometimes a lot) When the minor number is even, it means it's a stable branch, with only new features that don't break old ones, or bug fixes. The micro version indicates the origin of the release: even micro numbers are only used for released archives; odd micro numbers are only used on the Git repository. @@ -44,7 +42,6 @@ It's made of the major.minor version numbers. In stable branches, the API and th The ChangeLog File ------------------ - It is generated by calling the following command: $ git log --pretty=medium > ChangeLog @@ -52,7 +49,6 @@ It is generated by calling the following command: Creating a Tarball - The Release Process ---------------------------------------- - Make sure the RELEASE notes, the NEWS file are up-to-date. Make sure the version number in configure.ac is correct. Commit any pending changes. @@ -69,39 +65,24 @@ Create the tag in git. Update the version number in configure.ac to the next release to come. Make a new commit. -Creating a .pkg for OSX ------------------------ - -Configure a universal build, compile, and install into /tmp: - - $ ./configure --enable-universal --disable-dependency-tracking - $ - $ sudo make DESTDIR=/tmp/spatosc install - -Then run PackageMaker on the spatosc.pmdoc file - - -The RELEASE notes and the NEWS file ------------------------------------ +The NEWS file +------------- The NEWS file contains the release notes for the current (or next) release, and for all the releases before. We list there the bugs fixed and the new features. We also explain the reason for some changes if needed. The README File --------------- - We use the GNU Autotools, and Automake overwrites the INSTALL file. Therefore, we write the installation instructions in the README file, along with a quick explanation of how to use the software, and what it does. The TODO File ------------- - We store a list of things todo there. Historic -------- - Let's talk about the choices made in this library and software. We chose not to raise an exception if a given node is not found. We return a null pointer instead.