Arnaud Grausem avatar Arnaud Grausem committed 6d1bfc1

adding path informations and files created on filesystem

Comments (0)

Files changed (1)

-== Commander Adama ==
-
-Welcome to the Adama documentation ! Adama is a light and simple command line tool and API to create **commands** for your Python applications and also subcommands named **orders**
-
-
-=== Commands ===
-
-Imagine a little library that handles todo list. You named it pytodo and want a command that will handle the **add** order and the **done** order. Adama can brievely makes it work !
-
-{{{
-#!bash
-
-adama create_program pytodo
-}}}
-
-This will create the **pytodo python script** branched on your pytodo workong library. The only argument required by this script is the module's name of your library that must be on your pythonpath. If it doesn't, there is a global option --pythonpath to add a path to the pythonpath during the execution of the script. By default, the adama create_program creates a command with the same name of the module you passed as argument. You can change this by passing the --name option with the specific name you want for the command.
-
-Run 
-{{{
-#!bash
-
-python pytodo help
-}}}
-
-will show you
-{{{
-#!bash
-
-The "orders" module can not be found under the todolister package
-Usage: pytodo order [options] [args]
-
-
-
-Options:
-  -h, --help  show this help message and exit
-
-  Type 'pytodo help <order>' for help on a specific order.
-
-  Available orders:
-
-  No orders available.
-  Type 'adama create_order [options] todolister <order_name>' to create one
-}}}
-
-Ok. Next you want to see how to create new orders for your pytodo command
-
-=== Orders ===
-
-Adama comes with a create_order order that takes the module and the name of the order you want to create. This will add a new package named "orders" in the root path of your pytodo project.  
-
-{{{
-#!bash
-
-adama create_order pytodo add 
-}}}
+== Commander Adama ==
+
+Welcome to the Adama documentation ! Adama is a light and simple command line tool and API to create **commands** for your Python applications and also subcommands named **orders**
+
+
+=== Commands ===
+
+Imagine a little library that handles todo list. You named it pytodo and want a command that will handle the **add** order and the **done** order. Adama can brievely makes it work !
+\\
+{{{
+#!bash
+
+$> adama create_program pytodo
+$> ls
+pytodo
+}}}
+\\
+This will create the **pytodo python script** branched on your pytodo workong library. The only argument required by this script is the module's name of your library that must be on your pythonpath. If it doesn't, there is a global option --pythonpath to add a path to the pythonpath during the execution of the script. By default, the adama create_program creates a command with the same name of the module you passed as argument. You can change this by passing the --name option with the specific name you want for the command.
+
+Running **//pytodo help//** will show you :
+
+{{{
+#!bash
+
+$> pytodo help
+The "orders" module can not be found under the pytodo package
+Usage: pytodo order [options] [args]
+
+Options:
+  -h, --help  show this help message and exit
+
+  Type 'pytodo help <order>' for help on a specific order.
+
+  Available orders:
+
+  No orders available.
+  Type 'adama create_order [options] pytodo <order_name>' to create one
+
+}}}
+\\
+Ok, you didn't create order yet. Next you want to see how to create them for your pytodo command
+
+=== Orders ===
+
+Adama comes with a create_order order that takes the module and the name of the order you want to create. This will add a new package named "orders" in the root path of your pytodo project.  
+
+{{{
+#!bash
+
+$> adama create_order pytodo add 
+$> ls /path/to/pytodo/orders
+add.py  __init__.py
+}}}
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.