1
0
Fork 0
Browse Source

update README doc (main project overview).

stable
Craig Oates 3 years ago
parent
commit
6dae2040dc
  1. 58
      README.md
  2. BIN
      attachments/main-proj-architecture.png

58
README.md

@ -6,7 +6,8 @@ have cited about the other parties where taken from their respective
websites. I have, also, applied minor editing in places to help websites. I have, also, applied minor editing in places to help
readability - in the context of this file. Please use the links listed readability - in the context of this file. Please use the links listed
below for the original/official version of the sourced material. Craig below for the original/official version of the sourced material. Craig
is the author of the software in this repository.** is the author of the software for the 'Personal Flash in Real-Time'
project.**
## Return to Ritherdon Overview ## Return to Ritherdon Overview
@ -42,50 +43,51 @@ They were set up in 1946, by Royal Charter, to champion and develop
art and culture across the country. They are governed by an Executive art and culture across the country. They are governed by an Executive
Board and National and Area Councils. Board and National and Area Councils.
- [Arts Council England's Royal - [Arts Council England's Royal Charter](https://www.artscouncil.org.uk/sites/default/files/download-file/Consolidated_Royal_Charter_2013.pdf)
Charter](https://www.artscouncil.org.uk/sites/default/files/download-file/Consolidated_Royal_Charter_2013.pdf)
## Overview of Return to Ritherdon Docs (rtr-docs) ## Overview of Return to Ritherdon Docs (rtr-docs)
This repository houses the documentation for the, at the time of This repository houses the documentation for the 'Personal Flash in
writing, *unnamed project* which is one project within the much bigger Real-Time' project which is one project within the much bigger project
**Return to Ritherdon** project . The contents of the *unnamed called **Return to Ritherdon**. The contents of the 'Personal Flash in
project* consists of four smaller projects which are: Real-Time' consists of three smaller projects (and two secondary)
which are:
- [Light - [Light Meter](https://git.abbether.net/return-to-ritherdon/light-meter)
Meter](https://git.abbether.net/return-to-ritherdon/light-meter)
- [Relay](https://git.abbether.net/return-to-ritherdon/relay) - [Relay](https://git.abbether.net/return-to-ritherdon/relay)
- [Midpoint](https://git.abbether.net/return-to-ritherdon/relay) - [Midpoint](https://git.abbether.net/return-to-ritherdon/relay)
- [Eyes and
Ears](https://git.abbether.net/return-to-ritherdon/eyes-and-ears) The secondary projects are:
(this is a non-essential project and excluded from the diagrams
below to keep things simple -- at this introductory stage) - [Eyes and Ears](https://git.abbether.net/return-to-ritherdon/eyes-and-ears)
- [Light Wave](https://git.abbether.net/return-to-ritherdon/light-wave)
![Main Project Overview](attachments/return-to-ritherdon-project-overview.png) ![Main Project Overview](attachments/return-to-ritherdon-project-overview.png)
As you can see, 'Artwork 1' is what this repository is for, which is As you can see, 'Personal Flash in Real-Time' is what this repository
just one artwork/project within the much bigger 'Return to Ritherdon' is for, which is just one artwork/project within the much bigger
project. Within 'Artwork 1' is three smaller projects (listed and 'Return to Ritherdon' project. Within 'Personal Flash in Real-Time' is
linked above). Below is a quick summary of how the three projects three smaller projects (listed and linked above). Below is a quick
operate. (Please refer to the doc. files within this repo. for more summary of how the three projects operate. (Please refer to the
in-depth breakdowns of how this all works.) doc. files within this repo. for more in-depth breakdowns of how this
all works.)
![main-proj-architecture](attachments/main-proj-architecture.png) ![main-proj-architecture](attachments/main-proj-architecture.png)
### Goals of This Repository ### Goals of This Repository
The intention with this repository is to create a place which tracks The intention with this repository is to create a place which tracks
all the documentation changes across the *unnamed* project in one all the documentation changes across the 'Personal Flash in Real-Time'
place. This should help people whom are not exposed to the project in project in one place. This should help people whom are not exposed to
any sustained way have a single place they can go to for information the project in any sustained way have a single place they can go to
about the projects within *unnamed*. With that said, **the for information about the projects within 'Personal Flash in
documentation hosted here is for technicians and 'back of house' Real-Time'. With that said, **the documentation hosted here is for
staff**. The content within this repository does not prioritise technicians and 'back of house' staff**. The content within this
general public use. repository does not prioritise general public use.
You can read the documentation in this repository in two ways: You can read the documentation in this repository in two ways:
1. read the raw markdown (.md) files within the project folders in 1. read the raw markdown (.md) files within the project folders in
this repository, or; this repository, or;
2. download a 'Released' version and read that (as a .pdf). ~~2. download a 'Released' version and read that (as a .pdf).~~

BIN
attachments/main-proj-architecture.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 190 KiB

After

Width:  |  Height:  |  Size: 26 KiB