Skip to content

Commit

Permalink
docs: update README to reference setup script
Browse files Browse the repository at this point in the history
  • Loading branch information
ewang2002 committed Jan 29, 2024
1 parent e0cbcb7 commit 5e807e7
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,10 @@ about them, just click on the script name.

This program _requires_ the `webregautoin` helper program.

## Documentation
Basic documentation is provided in the [wiki](https://github.com/ewang2002/webreg_scraper/wiki).
## Setup
To run this project, feel free to explore the individual scripts or crates above; setup guides for each are provided.

If you want to get an Ubuntu environment ready with all the necessary files needed to run this project, you can run the setup script in the [`setup`](https://github.com/ewang2002/webreg_scraper/tree/master/setup) folder. More information will be provided there.

## License
Everything in this repository is licensed under the MIT license.

0 comments on commit 5e807e7

Please sign in to comment.