update doc for developers
This commit is contained in:
@ -15,7 +15,7 @@ infrastructure files which will be needed to build the project::
|
||||
$ wget https://github.com/scisoft/autocmake/raw/master/update.py
|
||||
$ python update.py --self
|
||||
|
||||
On the MS Windows system, use the PowerShell wget-replacement::
|
||||
On the MS Windows system, you can use the PowerShell wget-replacement::
|
||||
|
||||
$ Invoke-WebRequest https://github.com/scisoft/autocmake/raw/master/update.py -OutFile update.py
|
||||
|
||||
@ -23,13 +23,14 @@ 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
|
||||
autocmake.cfg # edit this file
|
||||
update.py # no need to edit
|
||||
lib/
|
||||
config.py # no need to edit
|
||||
docopt.py # no need to edit
|
||||
config.py # no need to edit
|
||||
docopt/
|
||||
docopt.py # no need to edit
|
||||
|
||||
Note that all other listed files are overwritten (use version control!).
|
||||
Note that all other listed files are overwritten (use version control).
|
||||
|
||||
|
||||
Generating the CMake infrastructure
|
||||
@ -38,7 +39,7 @@ Generating the CMake infrastructure
|
||||
Now customize ``autocmake.cfg`` to your needs
|
||||
(see :ref:`autocmake_cfg`)
|
||||
and then run the ``update.py`` script which
|
||||
creates ``CMakeLists.txt`` and ``setup.py``::
|
||||
creates ``CMakeLists.txt`` and ``setup.py`` in the target path::
|
||||
|
||||
$ python update.py ..
|
||||
|
||||
@ -46,12 +47,13 @@ The script also downloads external CMake modules specified in ``autocmake.cfg``
|
||||
called ``downloaded/``::
|
||||
|
||||
cmake/
|
||||
update.py
|
||||
autocmake.cfg
|
||||
autocmake.cfg # edit this file
|
||||
update.py # no need to edit
|
||||
lib/
|
||||
config.py
|
||||
docopt.py
|
||||
downloaded/ # contains CMake modules fetched from the web
|
||||
config.py # no need to edit
|
||||
docopt/
|
||||
docopt.py # no need to edit
|
||||
downloaded/ # contains CMake modules fetched from the web
|
||||
|
||||
|
||||
Building the project
|
||||
|
Reference in New Issue
Block a user