diff --git a/README.rst b/README.rst index 4bf43c78..09fcce46 100644 --- a/README.rst +++ b/README.rst @@ -1,11 +1,12 @@ -================= +################# Wikimedia Toolhub -================= +################# An authoritative and well promoted catalog of Wikimedia tools. +******* License -======= +******* Toolhub is licensed under the `GNU GPLv3+`_ license. .. _GNU GPLv3+: https://www.gnu.org/copyleft/gpl.html diff --git a/docs/CONTRIBUTING.rst b/docs/CONTRIBUTING.rst index 978feeaa..eb6e17ce 100644 --- a/docs/CONTRIBUTING.rst +++ b/docs/CONTRIBUTING.rst @@ -1,8 +1,46 @@ -================= +################# How to contribute -================= +################# -.. code-block:: shell-session +This document provides guidelines for people who want to contribute to the +Toolhub project. - $ docker-compose up --build -d - $ docker-compose run toolhub python3 manage.py migrate + +*********************** +Development environment +*********************** + +Dependencies +============ +The following software will need to be installed on your local development +machine: + +- Git_ +- Curl_ +- `Docker and Docker Compose`_ +- `GNU Make`_ + +Getting started +=============== +Toolhub's development environment is designed to allow you to test and run +everything from inside of a collection of Docker containers managed with +Docker Compose. The git repo contains a Makefile in its root directory that +should make working with `docker-compose` easier. + +.. highlight:: shell-session + +:: + + $ git clone https://github.com/bd808/toolhub + $ cd toolhub + $ make init + $ make test + + +Try running `make help` to see more make targets that you may find useful. + + +.. _Git: https://git-scm.com/ +.. _Curl: https://curl.haxx.se/ +.. _`Docker and Docker Compose`: https://www.docker.com/ +.. _`GNU Make`: https://www.gnu.org/software/make/