Merge pull request #69 from viperior/feature/revise-readme-project-structure

Improve the project structure documentation

Author: dagpunk

CHANGELOG.md

@@ -19,6 +19,7 @@
 ### Improvements
 
 - Move the tests related to the example module into example/tests (closes [#36](https://github.com/viperior/python-project-template/issues/36))
+- Improve the project structure documentation
 - Rename the `build` workflow to `test` (closes [#52](https://github.com/viperior/python-project-template/issues/52))
 - Simplify the import statement in the coin flip test case
 - Ignore `.venv` directory when linting with flake8 (closes [#53](https://github.com/viperior/python-project-template/issues/53))

README.md

@@ -38,9 +38,14 @@ python -m pytest
 ## Project structure
 
 ``` text
-project_root
-├───games_of_chance
-└───tests
+mainpackage/
+    subpackage/
+        __init__.py
+        samplemodule.py
+        tests/
+            __init__.py
+            test_one.py
+            test_two.py
 ```
 
 ## Resources