summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorPatryk Zawadzki <patrys@room-303.com>2013-10-16 14:43:11 +0200
committerPatryk Zawadzki <patrys@room-303.com>2013-10-16 14:43:11 +0200
commit4f7b0c7dce34f2fc59ba12676f8e4b33d563cdc8 (patch)
tree433e09e2a1e680216b815142ce61609ea876738a /README.md
parent7a398e49ab67304774920b230eb366c6ab5c8811 (diff)
downloadsaleor-frontend-4f7b0c7dce34f2fc59ba12676f8e4b33d563cdc8.tar.gz
saleor-frontend-4f7b0c7dce34f2fc59ba12676f8e4b33d563cdc8.tar.bz2
saleor-frontend-4f7b0c7dce34f2fc59ba12676f8e4b33d563cdc8.zip
Update README to suggest template use
Diffstat (limited to 'README.md')
-rw-r--r--README.md26
1 files changed, 16 insertions, 10 deletions
diff --git a/README.md b/README.md
index 28e368aa..356636a2 100644
--- a/README.md
+++ b/README.md
@@ -9,28 +9,34 @@ Avast ye landlubbers! Saleor be a Satchless store ye can fork.
Usage
-----
-1. Fork the repo on GitHub (you can skip this step if you like)
-1. `git clone` your repository
-1. Install it in development mode:
+1. Use `django-admin.py` to start a new project using Saleor as template:
+
+ ```
+ $ django-admin.py startproject --template=https://github.com/mirumee/saleor/archive/master.zip myproject
+ ```
+2. Enter the directory:
+
+ ```
+ $ cd myproject/
+ ```
+3. Install it in development mode:
```
$ python setup.py develop
```
(For production use `python setup.py install` instead.)
-1. Add a `SECRET_KEY` to your `settings.py` (we did not want to include one out of fear that you'd forget to change it)
-1. Prepare the database:
+4. Prepare the database¹:
```
$ saleor syncdb --all
```
-1. Run `saleor runserver`¹ to start the development server (on [localhost:8000](http://localhost:8000/))
-1. Edit the code to have it suite your requirements
-1. Run the tests to make sure everything works:
+5. Run `saleor runserver`¹ to start the development server
+6. Edit the code to have it suite your requirements
+7. Run the tests to make sure everything works:
```
$ python setup.py test
```
-1. Deploy!
+8. Deploy!
¹ `saleor` is a shortcut for running `python manage.py` so you can use it to execute all management commands.
-