diff --git a/README.md b/README.md index 22c8eed..13af95e 100644 --- a/README.md +++ b/README.md @@ -25,4 +25,20 @@ A free, open-source Blog CMS based on the "Django" and "Hyperspace" HTML5 theme. | ------------- | ------------- | ------------- | | [![](https://s17.picofile.com/file/8418101118/python.png)](https://www.python.org "Python") | [![](https://s17.picofile.com/file/8418100976/django.png)](https://www.djangoproject.com "Django") | [![](https://s17.picofile.com/file/8418101034/pycharm.png)](https://www.jetbrains.com/pycharm/ "Pycharm") | ------------- \ No newline at end of file +------------ +### How to install and run (GNU/Linux and Mac) + +1. Install `git`,`python3`, `pip3`, `virtualenv` in your operating system +2. Create a development environment ready by using these commands +``` +git clone https://github.com/mavenium/PyHyperspace # clone the project +cd PyHyperspace # go to the project DIR +virtualenv -p python3 .venv # Create virtualenv named .venv +source .venv/bin/activate # Active virtualenv named .venv +pip install -r requirements.txt # Install project requirements in .venv +python manage.py makemigrations # Create migrations files +python manage.py migrate # Create database tables +python manage.py collectstatic # Create statics files +python manage.py runserver # Run the project +``` +3. Go to `http://127.0.0.1:8000/` to use project \ No newline at end of file