Просмотр исходного кода

docs: add examples to CLI reference

Daniele Bartolini 8 лет назад
Родитель
Сommit
884d9cb779
1 измененных файлов с 18 добавлено и 0 удалено
  1. 18 0
      docs/command_line.rst

+ 18 - 0
docs/command_line.rst

@@ -1,6 +1,24 @@
 Command line reference
 ======================
 
+Examples
+--------
+
+Compile source data from ``/home/user/demo`` using a mapped ``core`` folder.
+
+.. code::
+
+	$ crown-development64 --source-dir /home/user/demo --map-source-dir core /home/user --compile
+
+Run the engine using compiled data from ``/home/user/demo_linux``:
+
+.. code::
+
+	$ crown-development64 --data-dir /home/user/demo_linux
+
+Options
+-------
+
 ``-h`` ``--help``
 	Display the help and quit.