Skip to content

Commit 56e2f7d

Browse files
docs: add a getting started guide
Signed-off-by: thiswillbeyourgithub <[email protected]>
1 parent bac8fc4 commit 56e2f7d

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -380,13 +380,20 @@ Dataset files (like `explainer_dataset.txt`, `reformulator_dataset.txt`, etc.) a
380380

381381
</details>
382382

383-
## Usage
383+
## Usage / Getting started
384384

385385
<details>
386386
<summary>
387387
Click to read more
388388
</summary>
389389

390+
To get started using those scripts (and until someone comes along to help me turn it into an addon!), the steps are roughly:
391+
0. **Note: if you don't understand those steps, I recommend self teaching you using LLMs. The steps always differ slightly depending on if you are on macos/linux/windows but the idea is always the same**
392+
1. Make sure you have python installed in your console. The recommended python version is 3.12.7 or 3.11.something because that's what I used at the time. If you try to use more recent versions you will probably encounter problems.
393+
2. git clone https://github.com/thiswillbeyourgithub/AnkiAIUtils/
394+
3. I recommend creating a virtual environment for python inside this new folder, for example `uv venv` then `source .venv/bin/activate` on my linux.
395+
4. Run a script, for that refer to the individual usage sections below.
396+
390397
#### Reformulator
391398
The Reformulator can be run from the command line:
392399

0 commit comments

Comments
 (0)