Update README

This commit is contained in:
Anonymous 2025-01-30 08:20:40 -05:00 committed by Chris Proctor
parent dd40c6b380
commit 55e67f2cad
1 changed files with 9 additions and 10 deletions

View File

@ -1,17 +1,16 @@
# 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 Djangos functionality, meant for beginners.
Banjo is an abstraction over [Django](https://www.djangoproject.com/) which
provides a simplified subset of Djangos functionality, meant for beginners.
A Banjo app consists of two files, `models.py` and `views.py`, within a 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
If you want to run this app on your computer, first install [poetry](https://python-poetry.org/).
Then open Terminal and run the following:
If you want to run this app on your computer, first install
[poetry](https://python-poetry.org/). Then open Terminal and run the following:
```
$ cd ~/Desktop
@ -21,5 +20,5 @@ $ poetry install
$ poetry run banjo
```
Your Terminal is now serving the riddle app. Open `http://localhost:8000/api` to see
the automatically-generated API pages.
Your Terminal is now serving the riddle app. Open `http://localhost:8000/api`
to see the automatically-generated API pages.