Skip to content

Commit 275e0b0

Browse files
Merge pull request #2 from SocialSchools/feat/update-readme
feat: update readme to make the wording a bit generic
2 parents 0d48496 + 1c8397a commit 275e0b0

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
1-
# django CMS Divio quickstart
1+
# django CMS quickstart
22

3-
A Dockerised django CMS project, ready to deploy on Divio or another Docker-based cloud platform, and run
4-
locally in Docker on your own machine. A Divio account is not required.
3+
A Dockerised django CMS project, ready to deploy on [Divio](https://www.divio.com/) or another Docker-based cloud platform, and run locally in Docker on your own machine.
54

65
This version uses Python 3.8 running and the most up-to-date versions of Django 3.1 and django CMS 3.8.
76

7+
## Installation
8+
9+
You need to have docker installed on your system to run this project.
10+
11+
- [Install Docker](https://docs.docker.com/engine/install/) here.
12+
- If you have not used docker in the past, please read this [introduction on docker](https://docs.docker.com/get-started/) here.
813

914
## Try it
1015

1116
```bash
12-
git clone git@github.com:divio/django-cms-divio-quickstart.git
13-
cd django-cms-divio-quickstart
17+
git clone git@github.com:django-cms/django-cms-quickstart.git
18+
cd django-cms-quickstart
1419
docker-compose build
1520
docker-compose run web python manage.py migrate
1621
docker-compose run web python manage.py createsuperuser
@@ -33,5 +38,8 @@ see sections that can be removed - in each case, the section is noted with a com
3338

3439
Options are also available for using Postgres/MySQL, uWSGI/Gunicorn/Guvicorn, etc.
3540

36-
Again, see [Deploy a new django CMS project using the Divio quickstart
37-
repository](https://docs.divio.com/en/latest/how-to/django-cms-deploy-quickstart/) for more guidance on customisation.
41+
## Contribution
42+
43+
This code for this project has been forked from Divio's quickstart repo. We are grateful for their valueable contribution to the code and documentation of this code.
44+
45+
You can follow the original repo [here](https://github.com/divio/django-cms-divio-quickstart/).

0 commit comments

Comments
 (0)