Skip to content

Commit

Permalink
docs: more work on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
bd808 committed Oct 14, 2020
1 parent 2ab0290 commit d5193b0
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 8 deletions.
7 changes: 4 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -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
48 changes: 43 additions & 5 deletions docs/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit d5193b0

Please sign in to comment.