diff --git a/doc/cmakelists.rst b/doc/cmakelists.rst deleted file mode 100644 index a573ea0..0000000 --- a/doc/cmakelists.rst +++ /dev/null @@ -1,28 +0,0 @@ - - -Generating the CMake infrastructure -=================================== - -Edit ``autocmake.cfg`` and run the ``update.py`` script which -creates ``CMakeLists.txt`` and ``setup.py`` in the build path:: - - python update.py .. - -The script also copies or downloads CMake modules specified in ``autocmake.cfg`` to a directory -called ``modules/``:: - - cmake/ - update.py - autocmake.cfg - lib/ - config.py - docopt.py - modules/ # CMakeLists.txt includes CMake modules from this directory - -Now you have ``CMakeLists.txt`` and ``setup.py`` in the project root and you can build -the project:: - - cd .. - python setup.py [-h] - cd build - make diff --git a/doc/index.rst b/doc/index.rst index f196ed6..cae4664 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -7,7 +7,6 @@ Autocmake :maxdepth: 2 about.rst - update.rst - cmakelists.rst + new-project.rst customizing-modules.rst updating-modules.rst diff --git a/doc/new-project.rst b/doc/new-project.rst new file mode 100644 index 0000000..143130d --- /dev/null +++ b/doc/new-project.rst @@ -0,0 +1,60 @@ + + +Building a new project +====================== + + +Bootstrapping Autocmake +----------------------- + +Download the ``update.py`` and execute it to fetch other infrastructure files +which will be needed to build the project:: + + mkdir cmake # does not have to be called "cmake" - take the name you prefer + cd cmake + wget https://github.com/scisoft/autocmake/raw/master/update.py + python update.py --self + +This creates (or updates) the following files (an existing ``autocmake.cfg`` is +not overwritten by the script):: + + cmake/ + update.py # no need to edit + autocmake.cfg # edit this file + lib/ + config.py # no need to edit + docopt.py # no need to edit + +Note that all other listed files are overwritten (use version control!). + + +Generating the CMake infrastructure +----------------------------------- + +Edit ``autocmake.cfg`` and then run the ``update.py`` script which +creates ``CMakeLists.txt`` and ``setup.py`` in the build path:: + + python update.py .. + +The script also copies or downloads CMake modules specified in ``autocmake.cfg`` to a directory +called ``modules/``:: + + cmake/ + update.py + autocmake.cfg + lib/ + config.py + docopt.py + modules/ # CMakeLists.txt includes CMake modules from this directory + + +Building the project +-------------------- + +Now you have ``CMakeLists.txt`` and ``setup.py`` in the project root and you can build +the project:: + + cd .. + python setup.py [-h] + cd build + make diff --git a/doc/update.rst b/doc/update.rst deleted file mode 100644 index 4032824..0000000 --- a/doc/update.rst +++ /dev/null @@ -1,24 +0,0 @@ - - -Bootstrapping a new project -=========================== - -Download the ``update.py`` and execute it to fetch other infrastructure files -which will be needed to build the project:: - - mkdir cmake # does not have to be called "cmake" - take the name you prefer - cd cmake - wget https://github.com/scisoft/autocmake/raw/master/update.py - python update.py --self - -This creates (or updates) the following files (an existing ``autocmake.cfg`` is -not overwritten by the script):: - - cmake/ - update.py # no need to edit - autocmake.cfg # edit this file - lib/ - config.py # no need to edit - docopt.py # no need to edit - -Note that all other listed files are overwritten (use version control!).