aboutsummaryrefslogtreecommitdiffstats
path: root/doc/configuration.rst
diff options
context:
space:
mode:
authorxliiv <tymoteusz.jankowski@gmail.com>2014-09-05 13:16:50 +0200
committerxliiv <tymoteusz.jankowski@gmail.com>2014-09-05 13:16:50 +0200
commit378b570ecce1fc9b16af79dcb8274f736654ed28 (patch)
tree5684bc9221393eabd7c46be870afb738dfb1e5d6 /doc/configuration.rst
parent60c073a6ed451cf91d9877a3305407756b9ffdce (diff)
parentf095351d856d4c4e4fd686adcb6dd3a34803e521 (diff)
downloadtipboard-378b570ecce1fc9b16af79dcb8274f736654ed28.tar.gz
tipboard-378b570ecce1fc9b16af79dcb8274f736654ed28.tar.bz2
tipboard-378b570ecce1fc9b16af79dcb8274f736654ed28.zip
Merge pull request #3 from xor-xor/minor_fixes
Minor fixes/improvements here and there (see descriptions of individual commits).
Diffstat (limited to 'doc/configuration.rst')
-rw-r--r--doc/configuration.rst21
1 files changed, 14 insertions, 7 deletions
diff --git a/doc/configuration.rst b/doc/configuration.rst
index a4d8f0b..c31bcd4 100644
--- a/doc/configuration.rst
+++ b/doc/configuration.rst
@@ -9,13 +9,13 @@ below (see section :ref:`installation`).
Default configuration
---------------------
-Tipboard launched after installation present a basic, empty layout – empty
-tiles in 2 lines with 4 columns each. If you want to modify them, create a
-"clean" config, where your changes will be introduced. Use the command::
+First thing that you need to do after successfull installation is to create an
+empty config that will provide a base for your customizations. Type in this
+command::
(tb-env)$ tipboard create_project <name_of_project>
-It will create the ``~/.tipboard`` dir with the following content:
+It will create ``~/.tipboard`` directory with the following content:
* ``settings-local.yaml`` file that defines the layout of tiles on the
dashboard you are creating;
@@ -35,8 +35,7 @@ It will create the ``~/.tipboard`` dir with the following content:
Launching Tipboard app
----------------------
-After you have logged in to your machine, you may launch Tipboard with the
-command::
+Having default config in place, you may launch Tipboard with the command::
(tb-env)$ tipboard runserver [<host>] [<port>]
@@ -44,6 +43,9 @@ command::
``localhost`` and ``7272``; if you want the application to listen on all the
network interfaces, set ``host`` to ``0.0.0.0``).
+You can now point your web browser to ``http://localhost:7272`` - you should
+see a basic, empty layout with tiles in 2 lines of 4 columns each.
+
Customising tile layout
-----------------------
@@ -137,7 +139,7 @@ One of the most useful functions is defining tiles to rotate. In a single
container (i.e. in one of the fields indicated by ``col_X_of_Y`` and
``row_X_of_Y``), you may define a few tiles to be displayed in this location as
items rotating at intervals defined in the configuration (similar to ads
-rotating on bus/tram stops, so-called *citylights*). To achieve that:
+rotating on bus/tram stops, so-called citylights). To achieve that:
* add the ``flip-time-xx`` class to a container, where ``xx`` is rotation
interval in seconds;
@@ -239,3 +241,8 @@ this behavior and rotate only certain dashboards, just add another parameter
taken into account, e.g.::
FLIPBOARD_SEQUENCE = ['my_first_dashboard', 'my_third_dashboard']
+
+.. note::
+
+ Every change in ``settings-local.py`` file requires restart of the
+ application.