Commit 689abf8b authored by Shashank Kumar's avatar Shashank Kumar

Update README.md to display pip installation.

parent 1e3aadb0
......@@ -4,7 +4,13 @@
### Description
A [GSoC 2018 project](https://summerofcode.withgoogle.com/projects/#5056989357408256) to help new contributors get started with open source contributions. Wizard/GUI is an application which brings together all the Tools and Tutorials necessary for a person to learn and start contributing to Open Source. The application contains different sections like Communication, Version Control System etc. and within each section, there are respective Tools and Tutorials.
Wizard/GUI is an application which brings together all the Tools and Tutorials necessary for a person to learn and start contributing to Open Source. The application contains different sections like Communication, Version Control System etc. and within each section, there are respective Tools and Tutorials.
A Tool is an up and running service right inside the application which can perform tasks to help the user understand the concepts. For example, encrypting a message using the primary key, decrypting the encrypted message using the private key, and so on, these tools can help the user better understand the concepts of encryption.
A tutorial is comprised of lessons which contain text, images, questions and code snippets. It is a comprehensive guide for a particular concept. For example, Encryption 101, How to use git?, What is a mailing list? and so on.
In addition to providing the Tools and Tutorials, this application is build to be progressive. One can easily contribute new Tutorials by just creating a JSON file, the process of which is documented in the project repository itself. Similarly, a documentation for contributing Tools is present as well.
### Project Management
......@@ -14,6 +20,19 @@ Project management is currently underway on [Redmine](https://outreach-lab.debia
- GNU/Linux OS (Tested on Debian 9)
- Python (Tested on Python => 3.5)
- Kivy (Tested on ==1.10.1)
### How To Install
This project has been packaged for [PyPi](https://pypi.org/project/new-contributor-wizard/) and can be downloaded using the below command
`pip install new-contributor-wizard`
### How To Run
Make sure you have all the [dependencies of Kivy](https://kivy.org/docs/gettingstarted/installation.html) installed. Then run:
`python3 -m new_contributor_wizard.main`
### Documentation
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment