Task Generation

README.md

@@ -1,29 +1,23 @@
-# Intent of this template
+### Contents
 
-The intent of this repo is to help you get started with creating Pydra tasks.
-All tasks will be inserted into pydra.tasks.<yourtaskpackagename> namespace.
+* `xmls`: a directory containing all the xmls from which pydra tasks should be generated.
+* `generate_tasks.py`: the script which automatically generates pydra tasks.
 
-# To use this template:
+### How to use
 
-1. Click on new repo.
-2. Select this template from the repository template drop down list.
-3. Give your repo a name.
-4. Once the repo is created and cloned, search for TODO (`grep -rn TODO . `) and
-  replace with appropriate name.
-5. One of the folders is called TODO. This should also be renamed to your package
-   name.
-6. Add tasks to the pydra/tasks/<yourpackagename> folder.
-7. You may want to initialize a sphinx docs directory.
-
-# TODO: Change this README after creating your new repo.
+`tools/generate_tasks.py` takes 2 optional arguments: the `output directory` and the `xml directory`.
 
+```bash
+python tools/generate_tasks.py [output directory] [xml directory]
+```
 
-## For developers
+* `output directory`: the directory that the generated tasks should be rooted at.
+If omitted the current working directory is used.
+* `xml directory`: a directory which contains xmls. The names of the xmls must match the names in module_list.
+If omitted binary files are used which must be found on the default path.
 
-Install repo in developer mode from the source directory. It is also useful to
-install pre-commit to take care of styling via black:
+### Command to use
 
-```
-pip install -e .[dev]
-pre-commit install
+```bash
+python tools/generate_tasks.py pydra/tasks/sem/ tools/xmls/
 ```