Skip to content

Commit

Permalink
update read me
Browse files Browse the repository at this point in the history
  • Loading branch information
HenryLi-0 committed Aug 22, 2024
1 parent 948fc07 commit 8536a5a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,15 @@ One option is clearly better here, you decide which... (clearly the second one)

Ok, time to get started!

### Images:

![](</demo.png>)

You can also find a video of it [here!](https://www.youtube.com/watch?v=9hZ3eRs_Sic)

### Getting Started:

First, make sure you have all the neccesary python modules to run this! (Any modules that don't come with python are listed below!) Then, download the latest release from the releases tab, and run `main.py`! Check `MANUAL.md` for a longer user manual on how to use this, and check `CODEGUIDE.md` if you're interested in where to find code!
First, make sure you have all the neccesary python modules installed to run this! (Any modules that don't come with python are listed below!) Then, either clone this repository, or download a recent release (either v1 or v1.1) from the releases tab, and run [`main.py`](/main.py)! Check [`MANUAL.md`](/MANUAL.md) for a longer user manual on how to use this, and check [`CODEGUIDE.md`](/CODEGUIDE.md) if you're interested in where to find code!

### Modules Used (that dont come with python):
- numpy
Expand Down
Binary file added demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 8536a5a

Please sign in to comment.