diff options
| author | davidpkj <davidpenkow1@gmail.com> | 2024-04-11 19:38:55 +0200 |
|---|---|---|
| committer | davidpkj <davidpenkow1@gmail.com> | 2024-04-11 19:38:55 +0200 |
| commit | dfb25ceae2b3212a4c17d8361143ba19f607dc49 (patch) | |
| tree | ebcedaea14a305307427cfdbfee87adfb1066797 | |
| parent | 613b153b8245f2509f5a4ce0609ccdddcecc7778 (diff) | |
readme
| -rw-r--r-- | README.adoc | 12 | ||||
| -rw-r--r-- | package.json | 2 |
2 files changed, 13 insertions, 1 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 +```` diff --git a/package.json b/package.json index 739d971..8afdaea 100644 --- a/package.json +++ b/package.json @@ -10,7 +10,7 @@ }, "devDependencies": {}, "scripts": { - "test": "node src/main.js" + "main": "node src/main.js" }, "author": "David Penkowoj", "license": "GPL-3.0-or-later", |