Skip to content

Commit

Permalink
Docs: clarify separation between windowed and headless mode
Browse files Browse the repository at this point in the history
  • Loading branch information
rlafuente committed Apr 28, 2018
1 parent 21632d8 commit c75258c
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/source/getstarted.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,14 @@ To get started, clone the Shoebot repository and head over to the `examples/` di
If everything went well with your installation, a window should open with an image.

Shoebot reads scripts written in the Nodebox language and translates them into images. In this case, the `-w` option (short for ``--window``) displays the output in a window. You can also have the result output directly into a file if you omit the ``-w`` option:
Shoebot reads scripts written in the Nodebox language and translates them into images or animations. In this case, the `-w` option (short for ``--window``) displays the output in a window.

You can right click anywhere on the image window to view the output in full screen or export it as an image or vector file.

Headless operation
------------------

You can also have the result output directly into a file if you omit the ``-w`` option:

.. code:: bash
Expand All @@ -23,4 +30,6 @@ This will create the ``balls.png`` image file. You can also create SVG, PDF and

For a list of extra options, there's always ``--help`` or ``-h``.

.. code:: bash
sbot -h

0 comments on commit c75258c

Please sign in to comment.