Document setup

This commit is contained in:
Vincent Riquer 2013-06-27 18:34:30 +02:00
parent c5b50565c5
commit 2fbeba3295
3 changed files with 12 additions and 3 deletions

8
README
View File

@ -46,7 +46,13 @@ Using the software
Configuration: Configuration:
-------------- --------------
Please read doc/config before anything else. On first run, AtOM will ask a set of questions to help you create a
configuration file.
You can run atom -S at any time to re-run the setup. It will be prefilled with
your current configuration.
If, however, you still want to make changes manually, please read doc/config.
There are a lot of comments in the generated config file too.
Preparing data: Preparing data:
--------------- ---------------

1
atom
View File

@ -65,6 +65,7 @@ help() {
-T <seconds> override load-interval -T <seconds> override load-interval
-F <destination> Force re-generation of all files in -F <destination> Force re-generation of all files in
<destination> <destination>
-S Run setup
-h Show this text -h Show this text
-D Increase debug -D Increase debug
EOF EOF

View File

@ -1,5 +1,7 @@
On first launch, AtOM will create an example configuration file for you. This is On first launch, AtOM will create a configuration file for you. The recommended
only an example, suitable to *my* needs (I'm lazy). way of changing your configuration is by running
$ atom -S.
Default config file is ~/.atom/atom.cfg. Default config file is ~/.atom/atom.cfg.
The file is divided in sections, beginning with [<sectionname>]. The section The file is divided in sections, beginning with [<sectionname>]. The section