aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2022-02-07 16:51:11 +0100
committerWojtek Kosior <koszko@koszko.org>2022-02-07 16:51:11 +0100
commit16eaeb86948349141b1e6072eb6540c7cece10b6 (patch)
treea5d69a3dbc448b15f016316db31c8280a13a1b10 /README.md
parentb5eb89e10762fb7e71c2e8e0cf28ab7c5206884a (diff)
downloadhydrilla-builder-16eaeb86948349141b1e6072eb6540c7cece10b6.tar.gz
hydrilla-builder-16eaeb86948349141b1e6072eb6540c7cece10b6.zip
move to a namespace package under 'hydrilla'
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index cb82a64..c633758 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,12 @@
-TODO... \ No newline at end of file
+# These are the sources of Hydrilla builder, a tool to convert packages into a form serveable by Hydrilla.
+
+TODO...
+
+To build the supplied example you can do something along the lines of:
+```
+mkdir /tmp/bananowarzez/
+PYTHONPATH=src python3 -m hydrilla.builder -s src/test/source-package-example/ \
+ -d /tmp/bananowarzez/
+# Now, list the files we just produced
+find /tmp/bananowarzez/
+```