Cool Crocodiles

.flake8

@@ -1,5 +1,6 @@
+[flake8]
 max-line-length=100
 application_import_names=projectt
 ignore=P102,B311,W503,E226,S311,W504,F821
-exclude=__pycache__, venv, .venv, tests
+exclude=__pycache__, venv, .venv, tests, crocpad/ui, crocpad/troubleshooter
 import-order-style=pycharm

.gitignore

@@ -102,3 +102,6 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+.vscode/settings.json
+notepad.ini
+.vscode/launch.json

Pipfile

@@ -7,9 +7,12 @@ verify_ssl = true
 flake8 = "*"
 
 [packages]
+pyqt5 = "*"
 
 [requires]
 python_version = "3.7"
 
 [scripts]
-lint = "python -m flake8"
+lint = "python -m flake8"
+start = "python -m crocpad"
+test = "python -m unittest discover -s crocpad"

README.md

@@ -30,16 +30,36 @@ You should be using [Pipenv](https://pipenv.readthedocs.io/en/latest/). Take a l
 
 # Project Information
 
-`# TODO`
+This is the Code Jam 4 entry for team Cool Crocodiles.
 
 ## Description
 
-`# TODO`
+Crocpad++ is a free replacement for Notepad.
 
 ## Setup & Installation
 
-`# TODO`
+Use `pipenv install` from the root directory.
 
 ## How do I use this thing?
 
-`# TODO`
+Use `pipenv run start` to run Crocpad++.
+
+## Project Structure
+`project/`  
+Contains the Crocpad++ application.
+
+`project/ui`  
+Contains `.ui` files created for Qt and the Python modules generated from those UI files.
+
+`project/sounds`  
+Contains sound resources for a multimedia, user-friendly experience.
+
+## Known bugs
+- When running under Linux, occasionally the following message might appear:  
+    >```qt.qpa.xcb: QXcbConnection: XCB error: 3 (BadWindow), sequence: 5441, resource id: 27411671, major code: 40 (TranslateCoords), minor code: 0```
+
+## Attributions
+`wrong.wav` is from https://freesound.org/people/sharesynth/sounds/341256/
+
+## Spoilers
+There are many subtle annoyances in Crocpad++. Please check `spoilers.txt` for a complete list.

azure-pipelines.yml

@@ -35,4 +35,7 @@ jobs:
     displayName: 'Install project dependencies'
 
   - script: pipenv run lint
-    displayName: 'Lint the project'
+    displayName: 'Lint the project'
+
+  - script: pipenv run test
+    displayName: 'Run unit tests'