Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
MeltedHugo committed Nov 28, 2018
2 parents 93bc2f4 + 93fc8f3 commit 89dbe0b
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# hab-schedule-parser
Parses the current schedule of lectures at the University of Applied Sciences Aschaffenburg to JSON files

At the moment, output from my own instance of this parser is synced to another repository every 30 minutes: [h-ab-schedule](https://github.com/Hugobert/h-ab-schedule). Head there if you just want access to the data.

## Binaries
If working with source code and Node.js is too complicated for you, just download the executable suited for your system [here](https://github.com/Hugobert/hab-schedule-parser/releases/latest). These should work out of the box without the need for any other software. Keep in mind that running those will try to create a directory named "json" in the folder they are executed in.

If you prefer working with the source code, continue reading.

## Requirements
* Node.js with npm
* An internet connection
Expand All @@ -9,4 +16,7 @@ Parses the current schedule of lectures at the University of Applied Sciences As
## How to use
1. Clone this repository.
2. Run `npm install` to install the dependencies.
3. Run `npm start` or `node main.js` to start the program.
3. Run `npm start` or `node main.js` to start the program.

## Contribution
If you find bugs or have ideas for improving this software, feel free to open an issue or a pull request.

0 comments on commit 89dbe0b

Please sign in to comment.