From a2f2165935dcbb3d15c39a0e5c059f74ac3c075e Mon Sep 17 00:00:00 2001 From: bkfox Date: Thu, 2 Jun 2016 01:37:19 +0200 Subject: [PATCH] doc --- README.md | 9 +++++---- cms/README.md | 6 ++++-- website/README.md | 6 +++--- 3 files changed, 12 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index c4f3733..2093089 100644 --- a/README.md +++ b/README.md @@ -11,9 +11,10 @@ Platform to manage a radio, schedules, website, and so on. We use the power of D * **log**: keep a trace of every played/loaded sounds on the stream generator. ## Applications -* **programs**: managing stations, programs, schedules and diffusions. This is the core application, that handle most of the work. -* **cms**: [optional] cms manager with reusable tools (can be used in another website application). -* **liquidsoap**: [optional] generate configuration and controls over liquidsoap. We use one instance of liquidsoap per station. +* **programs**: managing stations, programs, schedules and diffusions. This is the core application, that handle most of the work; +* **liquidsoap**: generate configuration and controls over liquidsoap. We use one instance of liquidsoap per station; +* **cms**: cms manager with reusable tools (can be used in another website application); +* **website**: set of common models, sections, and other items ready to be used for a website; ## Installation For now, we provide only applications availables under the aircox directory. Create a django project, and add the aircox applications directory. @@ -26,7 +27,7 @@ Later we would provide a package, but now we have other priorities. - dependencies: `'taggit'` (*programs* and *cms* applications), `'easy_thumbnails'` (*cms*), `'honeypot'` (*cms*) - optional dependencies (in order to make users' life easier): `'autocomplete_light'`, `'suit'` - - aircox: `'aircox.programs'`, `'aircox.liquidsoap'`, `'aircox.cms'` + - aircox: `'aircox.programs'`, `'aircox.liquidsoap'`, `'aircox.cms'`, `'aircox.website'` ### urls.py * dependencies: diff --git a/cms/README.md b/cms/README.md index ffd080a..457bff6 100644 --- a/cms/README.md +++ b/cms/README.md @@ -15,9 +15,11 @@ We aims here to automatize most common tasks and to ease website configuration. # Dependencies -* ```django-taggit```: publications tags +* `django-taggit`: publications' tags; +* `easy_thumbnails`: publications' images and previews; +* `django-honeypot`: comments anti-spam -Note: this application can be used outside Aircox if needed. +Note: this application can be used outside aircox if needed. # Architecture A **Website** holds all required informations to run the server instance. It diff --git a/website/README.md b/website/README.md index 363bba7..885f8be 100644 --- a/website/README.md +++ b/website/README.md @@ -8,9 +8,9 @@ We define here different models and sections that can be used to construct a website in a fast and simple manner. # Dependencies -* ```django-suit```: admin interface; -* ```django-autocomplete-light```: autocompletion in the admin interface; -* ```aircox.cms```, ```aircox.programs``` +* `django-suit`: admin interface; +* `django-autocomplete-light`: autocompletion in the admin interface; +* `aircox.cms`, `aircox.programs` # Features ## Models