version 0.1

README.md

@@ -1,61 +1,43 @@
 # README #
 
-This README would normally document whatever steps are necessary to get your application up and running.
+**cao_blogr** is mini app for blogging developed with the Pyramid framework
 
-### What is this repository for? ###
-
-* Quick summary
-* Version
-* [Learn Markdown](https://bitbucket.org/tutorials/markdowndemo)
-
-### How do I get set up? ###
+## How do I get set up? ##
 
 - Change directory into your newly created Pyramid project.
 
-    cd cao_blogr
+    ` cd cao_blogr `
 
 - Create a Python virtual environment.
 
-    python3 -m venv env
+    `python3 -m venv env `
 
 - Upgrade packaging tools.
 
-    env/bin/pip install --upgrade pip setuptools
+    `env/bin/pip install --upgrade pip setuptools `
 
 - Install the project in editable mode with its testing requirements.
 
-    env/bin/pip install -e ".[testing]"
+   ` 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"
+        `env/bin/alembic -c development.ini revision --autogenerate -m "init" `
 
     - Upgrade to that revision.
 
-        env/bin/alembic -c development.ini upgrade head
+        `env/bin/alembic -c development.ini upgrade head `
 
 - Load default data into the database using a script.
 
-    env/bin/initialize_cao_blogr_db development.ini
+    ` env/bin/initialize_cao_blogr_db development.ini `
 
 - Run your project's tests.
 
-    env/bin/pytest
+    ` env/bin/pytest `
 
 - Run your project.
 
-    env/bin/pserve development.ini
-
-
-### Contribution guidelines ###
-
-* Writing tests
-* Code review
-* Other guidelines
-
-### Who do I talk to? ###
-
-* Repo owner or admin
-* Other community or team contact
+    `env/bin/pserve development.ini `