Skip to content

Commit b227663

Browse files
committed
Adding a easy install and contribution section to README.md
1 parent 232a61e commit b227663

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,43 @@ locale-and-unicode aware. :)
1515
Want to learn more? [Read the documentation](http://turicas.info/rows) (or
1616
build and browse the docs locally by running `make docs-serve` after installing
1717
`requirements-development.txt`).
18+
19+
## Installation
20+
21+
The easiest way to getting the hands dirty is install rows, using
22+
pip.
23+
24+
### [PyPI][pypi-rows]
25+
26+
```bash
27+
pip install rows
28+
```
29+
30+
For another ways to instal refer to the Installation section [documentation][install-docs].
31+
32+
33+
## Contribution start guide
34+
35+
The preferred way to start contributing for the project is creating a virtualenv (you can do by using virtualenv,
36+
virtualenvwrapper, pyenv or whatever tool you'd like).
37+
38+
Create the virtualenv:
39+
40+
```bash
41+
mkvirtualenv rows
42+
```
43+
44+
Install all plugins' dependencies:
45+
46+
```bash
47+
pip install --editable .[all]
48+
```
49+
50+
Install development dependencies:
51+
52+
```bash
53+
pip install -r requirements-development.txt
54+
```
55+
56+
[pypi-rows]: https://pypi.org/project/rows/
57+
[install-docs]: https://turicas.info/rows/installation

0 commit comments

Comments
 (0)