diff --git a/README.md b/README.md index 3a298e2..16429d2 100644 --- a/README.md +++ b/README.md @@ -25,10 +25,10 @@ Wall requires: Run Wall with: - ./wall.py + ./wall.py [config_file] - * config_file: path to a config file (optional). Documentation is available in - the default config file (`wall/res/default.cfg`). + * config_file: path to a config file (optional). A sample in wall.cfg.sample + is available as documentation. Browser Support --------------- diff --git a/wall.cfg.sample b/wall.cfg.sample new file mode 100644 index 0000000..4598b77 --- /dev/null +++ b/wall.cfg.sample @@ -0,0 +1,21 @@ +# Sample Wall configuration. +# List items are space separated. +# Switches may either be set to `True` or `False`. + +[wall] + +# Server listen address and port +address = 127.0.0.1 +port = 8080 + +# Redis database index +db = 0 + +# debug mode +debug = False + +# short info text visible on the display +info = + +# list of bricks to load (given by Python module name) +bricks = wall.bricks.url wall.bricks.photo