docs: update README.md

This commit is contained in:
James Graham
2022-03-31 18:28:50 +01:00
parent 93487e3541
commit a4b2e085d8

View File

@@ -1,19 +1,28 @@
# BRECcIA-Mapper (provisional name) # BRECcIA Mapper
The canonical source for this project is hosted on [GitHub](https://github.com/Southampton-RSG/breccia-mapper), BRECcIA Mapper is a web app to collect and explore data about the relationships between researchers and their stakeholders on large-scale, multi-site research projects.
please log any issues there. This allows researchers to visually represent the relationships between project staff and stakeholders involved in the their project at different points in time.
Through this it is possible to explore the extent of networks and change over time, and identify where new relationships can be developed or existing ones strengthened.
BRECcIA-Mapper is a web app to collect and explore data about the relationships between researchers and their stakeholders on large-scale, multi-site research projects. This work was funded through the "Building REsearch Capacity for sustainable water and food security In drylands of sub-saharan Africa" (BRECcIA) project which is supported by UK Research and Innovation as part of the Global Challenges Research Fund, grant number NE/P021093/1.
TODO motivations, usage, license ## Deployment
## Technology
This project is written in Python using the popular [Django](https://www.djangoproject.com/) framework. This project is written in Python using the popular [Django](https://www.djangoproject.com/) framework.
Deployment is managed using [Ansible](https://www.ansible.com/) and Docker (https://www.docker.com/), see the `deploy/README.md` for details.
An [Ansible](https://www.ansible.com/) playbook is provided which is designed for deployment on RHEL7 or CentOS7 Linux systems. This installs and configures: ## Contributors
- MySQL
- Nginx
- Django + BRECcIA-Mapper
TODO deployment instructions - James Graham (@jag1g13) - developer
- Genevieve Agaba
- Sebastian Reichel
- Claire Bedelian
- Eunice Shame
- Fiona Ngarachu
- Gertrude Domfeh
- Henry Hunga
- Julie Reeves
## License
GPL-3.0 © University of Southampton