Skip to content

Commit

Permalink
Add documentation about autotools
Browse files Browse the repository at this point in the history
git-svn-id: svn://svn.code.sf.net/p/fuego/code/trunk@570 2e953b5c-c64d-0410-be54-f773e93e544c
  • Loading branch information
enz committed Oct 3, 2008
1 parent d7a9589 commit c3b97d9
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,10 @@ GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with Fuego. If not, see <http://www.gnu.org/licenses/>.

Compilation
===========

See INSTALL for generic compilation instructions from GNU Automake.
The file doc/general/pages/autotools.cpp contains additional and Fuego
specific documentation.
42 changes: 42 additions & 0 deletions doc/general/pages/autotools.cpp
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/** @page generalautotools Building Fuego using GNU Autotools
@section generalautotoolsdistro Building a distribution (released version)
@verbatim
./configure
make
@endverbatim
@section generalautotoolssvn Building a development version checked out from SVN
@verbatim
aclocal
autoheader
automake --add-missing
autoreconf
automake --add-missing
@endverbatim
The above commands need to be run only initially. Then the compilation works
as in the previous section.
After adding or removing files or doing other changes to
<tt>configure.in</tt> or a <tt>Makefile.am</tt>, you need to run
<tt>autoreconf</tt> again bevor doing a make.
A better way is to configure your makefiles with
<tt>./configure --enable-maintainer-mode</tt>. Then a make will automatically
check, if <tt>configure.in</tt> or a <tt>Makefile.am</tt> have changed and
recreate the makefiles bevor the compilation if necessary.
Other interesting options to configure are @c --enable-assert for enabling
assertions or @c --enable-optimize=no for switching off optimizations.
<tt>./configure --help</tt> returns a full list of options.
@section generalautotoolsinstall Installing Fuego
@verbatim
sudo make install
@endverbatim
*/

1 change: 1 addition & 0 deletions doc/general/pages/mainpage.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@
- @ref generalstyle
- @ref generalgmake
- @ref generalautotools
*/

0 comments on commit c3b97d9

Please sign in to comment.