From 5e807e757f2c863d6b6639ab5e492728b843a9b3 Mon Sep 17 00:00:00 2001 From: ewang2002 <37031713+ewang2002@users.noreply.github.com> Date: Mon, 29 Jan 2024 13:12:08 -0800 Subject: [PATCH] docs: update README to reference setup script --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0ed6c47..c28f12e 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file