chore: Add tox-tests.yml, update README.md

.github/workflows/tox-tests.yml

@@ -0,0 +1,56 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.platform }}
+    strategy:
+      fail-fast: false
+      matrix:
+        exclude:
+          - platform: ubuntu-latest
+            python-version: 3.12
+          - platform: macos-latest
+            python-version: 3.7
+        # https://help.github.com/articles/virtual-environments-for-github-actions
+        platform:
+          - ubuntu-latest  # ubuntu-22.04
+          - macos-latest  # macOS-12
+          - windows-latest  # windows-2022
+        python-version: [3.7, 3.8, 3.9, '3.10', 3.11, 3.12, pypy-3.7, pypy-3.8, pypy-3.9, pypy-3.10]
+
+    steps:
+    - uses: actions/checkout@v3
+      if: ${{ ! startsWith(matrix.python-version, 'pypy-') }}
+    - uses: actions/checkout@v1
+      if: ${{ startsWith(matrix.python-version, 'pypy-') }}
+      # Using actions/checkout@v2 or later with pypy causes an error
+      # https://foss.heptapod.net/pypy/pypy/-/issues/3640
+      # py.error.ENOENT: [No such file or directory]:
+      # listdir('/home/runner/work/tox-gh-actions/tox-gh-actions/.tox/dist/
+      # warnings.warn(f\'"{wd.path}" is shallow and may cause errors\')',)
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade setuptools pip wheel
+        # Use the latest published version for myself :)
+        python -m pip install --pre tox-gh-actions
+    - name: Test with tox
+      run: tox
+    - name: Upload coverage.xml
+      if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == '3.12' }}
+      uses: actions/upload-artifact@v3
+      with:
+        name: tox-gh-actions-coverage
+        path: coverage.xml
+        if-no-files-found: error
+    - name: Upload coverage.xml to codecov
+      if: ${{ matrix.platform == 'ubuntu-latest' && matrix.python-version == '3.12' }}
+      uses: codecov/codecov-action@v2

README.md

@@ -3,6 +3,8 @@
 [![Publish to PyPI.org](https://github.com/tomasvana10/crossword_puzzle/actions/workflows/publish.yml/badge.svg)](https://github.com/tomasvana10/crossword_puzzle/actions/workflows/publish.yml)
 [![release)](https://img.shields.io/github/v/release/tomasvana10/crossword_puzzle?logo=github)](https://github.com/tomasvana10/crossword_puzzle/releases/latest)
 [![issues](https://img.shields.io/github/issues-raw/tomasvana10/crossword_puzzle.svg?maxAge=25000)](https://github.com/tomasvana10/crossword_puzzle/issues)
+[![CodeQL](https://github.com/tomasvana10/crossword_puzzle/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/tomasvana10/crossword_puzzle/actions/workflows/github-code-scanning/codeql)
+[![Tests](https://github.com/tomasvana10/crossword_puzzle/actions/workflows/tox-tests.yml/badge.svg)](https://github.com/tomasvana10/crossword_puzzle/actions/workflows/tox-tests.yml)
 
 # crossword_puzzle
 A GUI package built with `CustomTkinter` that allows you to select, configure and generate a crossword to view, interact with and complete in a `Flask` web application.
@@ -18,19 +20,22 @@ A GUI package built with `CustomTkinter` that allows you to select, configure an
 <br><br>
 ## Installation
 **Requires [pip](https://pip.pypa.io/en/stable/installation/)**
-<br>
+
 Make a virtual environment (recommended)
 ```
 pip install virtualenv OR pip3 install virtualenv
 python -m venv venv OR python3 -m venv venv
 ON MACOS/UNIX: source venv/bin/activate
-ON WINDOW: venv\scripts\activate
+ON WINDOWS: venv\scripts\activate
 ```
 
-Install the package and run the gui script:
+Install the package in your system directory/virtual environment:
+```
+pip install -U crossword-puzzle OR pip3 install -U crossword-puzzle
+```
+OR, install the package in your home directory (good if you aren't using a virtual environment):
 ```
-pip install crossword_puzzle OR pip3 install crossword_puzzle
-crossword-ctk
+pip install --user -U crossword-puzzle
 ```
 
 ## Documentation
@@ -55,4 +60,4 @@ Check out the wiki [here](https://github.com/tomasvana10/crossword_puzzle/wiki)
 <hr>
 <img width="1240" alt="game english" src="https://github.com/tomasvana10/crossword_puzzle/assets/124552709/6c313430-58df-4075-a417-b0150968be82">
 <hr>
-<img width="1240" alt="game japanese" src="https://github.com/tomasvana10/crossword_puzzle/assets/124552709/92e84095-05ff-413f-b397-0c407e71d713">
+<img width="1240" alt="game japanese" src="https://github.com/tomasvana10/crossword_puzzle/assets/124552709/92e84095-05ff-413f-b397-0c407e71d713">