From 3cd48a965191ad98addbc37cf6ff09b2f59c7646 Mon Sep 17 00:00:00 2001 From: tomasv Date: Sat, 16 Mar 2024 12:27:38 +1100 Subject: [PATCH] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1e547dd44..cf91ceee4 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,19 @@ A GUI application built with `CustomTkinter` that allows you to select, configur `regex==2023.6.3`

## Installation +Requires [pip](https://pip.pypa.io/en/stable/installation/) and [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) 1. `git clone https://github.com/tomasvana10/crossword_puzzle.git` 2. `cd crossword_puzzle` -3. Make a virtual environment (recommended) +3. Make a virtual environment with [virtualenv](https://virtualenv.pypa.io/en/latest/) (recommended) - `pip install virtualenv` - `python3 -m venv venv` - - Windows: `venv\Scripts\activate`, Unix/MacOS: `source venv/bin/activate` + - Windows: `venv\Scripts\activate` + - Unix/MacOS: `source venv/bin/activate` 4. `pip install -r requirements.txt` 5. `python3 src/main.py` (if this doesn't work, try using `python` instead of `python3`)

-## Usage -Will create external user documentation and add it to the repository eventually. +## Documentation +Check out the wiki [here](https://github.com/tomasvana10/crossword_puzzle/wiki)

## Third-party library acknowledgements - [CSS Pattern](https://css-pattern.com) - Background CSS patterns