Anonymous avatar Anonymous committed d5ec567

Add config file informations to README.

Comments (0)

Files changed (1)

 instance.
 
 
+CONFIGURATION FILE
+-------------------
+Various options to smart-live-rebuild may be set in a configuration file too.
+The path to that file can be specified as '--config-file' (or '-c'), and
+the default one is '~/.config/smart-live-rebuild.conf'.
+
+The configuration file has a format similar to Windows .ini files, where all
+the options need to be in '[smart-live-rebuild]' section. The keys for respe-
+ctive options match the command-line argument names, with 'no-' prefix stripped
+and all dashes ('-') changed into underscores ('_').
+
+The values for boolean types can be specified in any way suitable for
+ConfigParser python class (i.e. true/false/yes/no/on/off). The 'type' list
+has to be comma-separated.
+
+Example config file may look like:
+
+[smart-live-rebuild]
+jobs=3
+erraneous_merge=no
+type=git,subversion
+
+Additionally, configuration files can be chained. To do so, just specify path
+to the next configuration file as 'config_file'. Please notice though that
+currently they aren't read in reverse order, so further configuration files will
+replace values set by yours.
+
+
 CONTACT / BUG REPORTING
 ------------------------
 http://mgorny.alt.pl/contact.html
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.