Initial commit

1 files changed, 44 insertions, 0 deletions

diff --git a/README.txt b/README.txt
new file mode 100644
index 0000000..8a6b0e7
--- /dev/null
+++ b/README.txt
@@ -0,0 +1,44 @@
+fietsboek
+=========
+
+Getting Started
+---------------
+
+- Change directory into your newly created project if not already there. Your
+  current directory should be the same as this README.txt file and setup.py.
+
+    cd fietsboek
+
+- Create a Python virtual environment, if not already created.
+
+    python3 -m venv env
+
+- Upgrade packaging tools, if necessary.
+
+    env/bin/pip install --upgrade pip setuptools
+
+- Install the project in editable mode with its testing requirements.
+
+    env/bin/pip install -e ".[testing]"
+
+- Initialize and upgrade the database using Alembic.
+
+    - Generate your first revision.
+
+        env/bin/alembic -c development.ini revision --autogenerate -m "init"
+
+    - Upgrade to that revision.
+
+        env/bin/alembic -c development.ini upgrade head
+
+- Load default data into the database using a script.
+
+    env/bin/initialize_fietslog_db development.ini
+
+- Run your project's tests.
+
+    env/bin/pytest
+
+- Run your project.
+
+    env/bin/pserve development.ini