Skip to content

Commit

Permalink
docs: make install instructions more clear
Browse files Browse the repository at this point in the history
  • Loading branch information
b1rger committed Nov 13, 2023
1 parent f08b10c commit e6a4efe
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Installation
Create a project using your favourite package manager:

```shell
poetry new foobar --name apis_ontology
poetry new foobar-repository --name apis_ontology
```

Currently (as of 2023-10) the name of the apis application **has** to be
Expand All @@ -62,8 +62,7 @@ poetry add git+https://github.com/acdh-oeaw/apis-core-rdf#v0.6.1

Setup your Django project
```shell
rm -rf apis_ontology
poetry run django-admin startproject apis_ontology .
poetry run django-admin startproject foobar_django_project .
```

Now start using your Django project
Expand Down Expand Up @@ -107,6 +106,14 @@ To use the APIS framework in your application, you will need to add the followin

```

Also, add the following two [context processors](https://docs.djangoproject.com/en/4.2/ref/templates/api/#django.template.RequestContext):
```
# we need this for listing entities in the base template
"apis_core.context_processors.custom_context_processors.list_entities",
# we need this for accessing `basetemplate`
"apis_core.context_processors.custom_context_processors.list_apis_settings",
```

Finally, add the APIS urls to your applications [URL Dispatcher](https://docs.djangoproject.com/en/4.2/topics/http/urls/):
```python
from django.urls import include
Expand Down

0 comments on commit e6a4efe

Please sign in to comment.