Commit 46046509 authored by Lars Hupel's avatar Lars Hupel
Browse files

update README

--HG--
branch : config
parent cf827a98d585
......@@ -17,7 +17,6 @@ files.
Optional:
contributors = <contributor1> [<<url1>>], <contributor2> ...
depends-on = <entry name> [, <entry name> ..]
license = LGPL
Example:
......@@ -78,12 +77,6 @@ files.
Allowed values are BSD and LGPL.
Optionally, it can be documented which other entries are used by the
entry, using the depends-on key with a comma-separated list of entry
names:
depends-on = Refine_Monadic, Collections
Finally, sometimes existing entries get significant contributions from
other authors. These authors can be listed on a 'contributors' line.
A separate change-history entry should indicated what these people
......@@ -157,43 +150,23 @@ the script.
In most cases, you don't have to change these generator lines.
Invoking sitegen.py
-------------------
When invoking without arguments, the following help is displayed:
Invoking sitegen
----------------
Usage: sitegen.py [--no-warn] [--debug] [--check=THYS_DIR | --dest=DEST_DIR] metadata-dir
The script can be invoked without any arguments:
The script requires one parameter to pass specifying the metadata folder.
Secondly, you must specify at least one action (--check or --dest)
(examples assume that you are in the root of the repository):
./admin/sitegen
--check=THYS_DIR
Optionally, the following flags can be supplied:
If you specify the 'thys' folder, the script will perform a check whether
the entries in the metadata file corresponds to the folders in the
filesystem.
Example:
--check
admin/sitegen.py --check=thys metadata
The script will perform a check whether the entries in the metadata file
corresponds to the folders in the filesystem.
You might want to specify --no-warn when using --check if you're only
interested in checking the rough structure of the metadata file.
--dest=DEST_DIR
If you specify a destination folder, the script will look for templates in
the metadata folder and generate a corresponding file in the destination
folder.
Example:
admin/sitegen.py --dest=/tmp/web metadata
You may wish to supply both --check and --dest.
The other parameters are optional. Provide --help to get an explanation.
--no-warn
Disable warnings. The script will occasionally complain about
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment