Update README
This commit is contained in:
parent
dd40c6b380
commit
55e67f2cad
19
README.md
19
README.md
|
@ -1,17 +1,16 @@
|
||||||
# Example Banjo app
|
# Example Banjo app
|
||||||
|
|
||||||
[Banjo](https://django-banjo.readthedocs.io) i
|
[Banjo](https://django-banjo.readthedocs.io) is an abstraction over
|
||||||
|
[Django](https://www.djangoproject.com/) which provides a simplified subset
|
||||||
|
of Django’s functionality, meant for beginners.
|
||||||
|
|
||||||
Banjo is an abstraction over [Django](https://www.djangoproject.com/) which
|
A Banjo app consists of two files, `models.py` and `views.py`, within a
|
||||||
provides a simplified subset of Django’s functionality, meant for beginners.
|
directory called `app`. The app is run by calling `banjo`.
|
||||||
|
|
||||||
A Banjo app consists of two files, `models.py` and `views.py`, within a directory
|
|
||||||
called `app`. The app is run by calling `banjo`.
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
If you want to run this app on your computer, first install [poetry](https://python-poetry.org/).
|
If you want to run this app on your computer, first install
|
||||||
Then open Terminal and run the following:
|
[poetry](https://python-poetry.org/). Then open Terminal and run the following:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ cd ~/Desktop
|
$ cd ~/Desktop
|
||||||
|
@ -21,5 +20,5 @@ $ poetry install
|
||||||
$ poetry run banjo
|
$ poetry run banjo
|
||||||
```
|
```
|
||||||
|
|
||||||
Your Terminal is now serving the riddle app. Open `http://localhost:8000/api` to see
|
Your Terminal is now serving the riddle app. Open `http://localhost:8000/api`
|
||||||
the automatically-generated API pages.
|
to see the automatically-generated API pages.
|
||||||
|
|
Loading…
Reference in New Issue