aboutsummaryrefslogtreecommitdiff
path: root/README.adoc
diff options
context:
space:
mode:
Diffstat (limited to 'README.adoc')
-rw-r--r--README.adoc12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.adoc b/README.adoc
index e69de29..ed9da74 100644
--- a/README.adoc
+++ b/README.adoc
@@ -0,0 +1,12 @@
+= Stundenplan
+
+A small JavaScript project to generate beautiful PDF schedules. Takes information from `src/variables.js`. Planning to use direct UnivIS-XML export.
+
+== Usage
+
+Requires the `npm` tool.
+
+```bash
+npm i # installes packages
+npm run main # runs the software
+````