Adjusted "Project template" section to indicate the files and folder created by the template.
@@ -304,6 +304,32 @@ Remove the Cookiecutter virtual environment.
$ rm -r cookiecutter-venv
+You will now have the following files and folders.
+
+::
+
+ ./your_project
+ ./your_project/.editorconfig
+ ./your_project/.flake8
+ ./your_project/.github
+ ./your_project/.github/workflows
+ ./your_project/.github/workflows/github-actions.yml
+ ./your_project/.gitignore
+ ./your_project/LICENSE
+ ./your_project/Makefile
+ ./your_project/README.md
+ ./your_project/mypy.ini
+ ./your_project/pyproject.toml
+ ./your_project/pytest.ini
+ ./your_project/tests
+ ./your_project/tests/__init__.py
+ ./your_project/tests/test_application.py
+ ./your_project/your_project
+ ./your_project/your_project/__init__.py
+ ./your_project/your_project/application.py
+ ./your_project/your_project/domainmodel.py
+ ./your_project/your_project/py.typed
+
Start using your eventsourcing project.
::
@@ -315,8 +341,6 @@ The ``make install`` command uses the build tool Poetry to create a dedicated
Python virtual environment for your eventsourcing project, and installs popular
development dependencies such as Black, isort and pytest.
-Add tests in ``./tests``. Add code in ``./your_project``.
-
Run tests.
::
@@ -329,6 +353,8 @@ Check the syntax and formatting of your code.
$ make lint
+Add test code in ``./tests`` and code under test in ``./your_project``.
+
The project template includes the "dog school" example.
You can adjust the tests, rename the classes, and change the methods.
Or just delete the included example code for a fresh start.
