Skip to content

Commit 58e6581

Browse files
committed
feat: add installation instruction
1 parent 549143f commit 58e6581

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

examples/README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Examples
2+
3+
## Running Locally: One-click Install
4+
5+
In this directory, there is an `install.bat` and `install.sh` file. These files will install the required dependencies and run the program, including python 3.10.12 (or higher), pip, and mastermind-ai.
6+
7+
- If you're using an windows machine, download and double click to run `install.bat`.
8+
- Otherwise, download and run `install.sh` in your terminal by:
9+
10+
```bash
11+
cd [path]
12+
chmod +x install.sh
13+
./install.sh
14+
```
15+
16+
Replace `[path]` with the path to the directory containing `install.sh`, or ignore it if you already opened your terminal in the directory.
17+
18+
## Running Remotely: Google Colab
19+
20+
- Open [this link](https://colab.research.google.com/github/FlysonBot/Mastermind/blob/main/examples/mastermind_in_colab.ipynb) to open the program in Google Colab.

0 commit comments

Comments
 (0)