-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
47 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/ |