Quellcode durchsuchen

Merge branch 'master' of https://github.com/wagtail/bakerydemo

Scot Hacker vor 8 Jahren
Ursprung
Commit
f3f2f4fd09
2 geänderte Dateien mit 18 neuen und 11 gelöschten Zeilen
  1. 1 1
      .gitignore
  2. 17 10
      readme.md

+ 1 - 1
.gitignore

@@ -3,6 +3,7 @@
 *.log
 *.log
 *.swp
 *.swp
 *.retry
 *.retry
+.env
 *~
 *~
 /logs
 /logs
 /data
 /data
@@ -16,4 +17,3 @@ __pycache__
 /.vagrant/
 /.vagrant/
 /Vagrantfile.local
 /Vagrantfile.local
 !.gitignore
 !.gitignore
-

+ 17 - 10
readme.md

@@ -6,11 +6,17 @@ This is a demonstration project for [Wagtail CMS](http://wagtail.io).
 *We do __not__ recommend using this project to start your own site*. This project is only to provide some examples of
 *We do __not__ recommend using this project to start your own site*. This project is only to provide some examples of
 implementing common features, it is not an exemplar of Django or Wagtail best practice.
 implementing common features, it is not an exemplar of Django or Wagtail best practice.
 
 
-If you're reasonably new to Python/Django, we suggest you run this project on a Virtual Machine using Vagrant, which
-helps  resolve common software dependency issues. However for more experienced developers, instructions to start this
-project without Vagrant follow below.
+This project can be installed in one of three ways:
 
 
-Once you're familiar with the examples in this project and you want to start a real site, we strongly recommend running
+- Vagrant
+- Docker
+- Traditional/manual Django setup
+
+If you're new to Python/Django, we suggest you run this project on a Virtual Machine using Vagrant or
+via Docker, both of which help resolve common software dependency issues. Developers more familiar with
+virtualenv and traditional Django app setup instructions should use the Local Setup instructions below.
+
+Once you're familiar with the examples in this project and you want to start a real site, run
 the ``wagtail start`` command in a fresh virtual environment, explained in the
 the ``wagtail start`` command in a fresh virtual environment, explained in the
 [Wagtail CMS Documentation](http://wagtail.readthedocs.org/en/latest/getting_started/).
 [Wagtail CMS Documentation](http://wagtail.readthedocs.org/en/latest/getting_started/).
 
 
@@ -70,15 +76,16 @@ docker-compose logs -f
 
 
 Local Setup
 Local Setup
 -----------
 -----------
-Don't want to set up a whole VM nor use Docker to try out Wagtail? No problem.
-
-### Dependencies
-* [PIP](https://github.com/pypa/pip)
+Don't want to set up a whole Vagrant VM or use Docker to try out Wagtail? No problem. You'll probably want to start
+with a fresh virtualenv.
 
 
 ### Installation
 ### Installation
 
 
-With PIP installed run the following commands:
+With [PIP](https://github.com/pypa/pip) and [virtualenvwrapper](https://virtualenvwrapper.readthedocs.io/en/latest/)
+installed, run:
 
 
+    mkvirtualenv wagtailbakerydemo
+    cd ~/dev [or your preferred dev directory]
     git clone git@github.com:wagtail/bakerydemo.git
     git clone git@github.com:wagtail/bakerydemo.git
     cd wagtaildemo
     cd wagtaildemo
     pip install -r requirements.txt
     pip install -r requirements.txt
@@ -89,7 +96,7 @@ to help with this. It reads environment variables located in a file name .env in
     $ cp bakerydemo/settings/local.py.example bakerydemo/settings/local.py
     $ cp bakerydemo/settings/local.py.example bakerydemo/settings/local.py
     $ echo "DJANGO_SETTINGS_MODULE=bakerydemo.settings.local" > .env
     $ echo "DJANGO_SETTINGS_MODULE=bakerydemo.settings.local" > .env
 
 
-Execute the following commands:
+To set up your database and load initial data, run the following commands:
 
 
     ./manage.py migrate
     ./manage.py migrate
     ./manage.py load_initial_data
     ./manage.py load_initial_data