Skip to content

Commit 51dfa52

Browse files
author
Tim-ats-d
committed
Add CONTRIBUTION.md. Some changes in README.md (edit pip command to install lib). Edit .gitignore
1 parent d076361 commit 51dfa52

File tree

1 file changed

+72
-0
lines changed

1 file changed

+72
-0
lines changed

CONTRIBUTING.md

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
2+
# Contributing
3+
4+
## Setup your development environment
5+
6+
You need:
7+
* `Python3.6`: you can install it by following [Python3's documentation](https://www.python.org/downloads/).
8+
* `curses`: available in standard library of `Python` but it doesn't work out-of-the-box on Windows. See [this](https://www.devdungeon.com/content/curses-windows-python) explanations to install `curses` on Windows.
9+
10+
## Branches
11+
12+
* main : stable releases.
13+
14+
To fix a minor problem or add new features create a new branch in this form: `username-dev`.
15+
Please test your code with `Python3.6` version before **pull request** to be sure not to break compatability.
16+
17+
## Download
18+
19+
Download projet:
20+
```bash
21+
git clone https://github.com/Tim-ats-d/Visual-dialog
22+
```
23+
24+
Install Visual-dialog using `pip`:
25+
```bash
26+
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog
27+
```
28+
or update lib to the latest version:
29+
```bash
30+
python3 -m pip install git+git://github.com/Tim-ats-d/Visual-dialog --upgrade
31+
```
32+
The list of versions and their changelogs can be found [here](https://github.com/Tim-ats-d/Visual-dialog/releases/).
33+
34+
## Repository Structure
35+
36+
The following snippet describes Visual-dialog's repository structure.
37+
38+
```text
39+
.
40+
├── .github/
41+
| Contains Github specific files such as actions definitions and issue templates.
42+
43+
├── doc/
44+
| Contains documentation.
45+
│ │
46+
│ ├── examples/
47+
│ │ Contains several examples of how to use Visual-dialog.
48+
│ │
49+
│ └── documentation.md
50+
│ Documentation of public API (coming soon).
51+
52+
├── visualdialog/
53+
| Source for Visual-dialog's library.
54+
│ │
55+
| ├── __init__.py
56+
│ │
57+
| └── core.py
58+
| Contains Visual-dialog's core functionnalities.
59+
60+
├── LICENSE
61+
62+
├── CONTRIBUTING.md
63+
│ This document.
64+
65+
├── MANIFEST.in
66+
│ Contains list of non Python file.
67+
68+
├── README.md
69+
70+
└── setup.py
71+
Installation of the library.
72+
```

0 commit comments

Comments
 (0)