File tree Expand file tree Collapse file tree 1 file changed +49
-0
lines changed Expand file tree Collapse file tree 1 file changed +49
-0
lines changed Original file line number Diff line number Diff line change @@ -4,3 +4,52 @@ Yet another python index generator
4
4
5
5
[ ![ Travis] ( https://img.shields.io/travis/BruceZhang1993/index-generator.svg?style=for-the-badge )] ( https://travis-ci.org/BruceZhang1993/index-generator )
6
6
[ ![ PyPI] ( https://img.shields.io/pypi/v/index-generator.svg?style=for-the-badge )] ( https://pypi.org/project/index-generator )
7
+
8
+ ## Install
9
+
10
+ ### GitHub master branch
11
+
12
+ ``` bash
13
+ git clone https://github.com/BruceZhang1993/index-generator.git
14
+ cd index-generator
15
+ sudo python setup.py install
16
+ # OR
17
+ sudo pip install .
18
+ ```
19
+
20
+ ### GitHub release
21
+
22
+ ``` bash
23
+ # Coming soon
24
+ ```
25
+
26
+ ### Pypi
27
+
28
+ ``` bash
29
+ # Coming soon
30
+ ```
31
+
32
+ ### Distributions
33
+
34
+ #### Arch Linux
35
+
36
+ ``` bash
37
+ # Coming soon
38
+ ```
39
+
40
+ #### Other Distribution
41
+
42
+ ## Usage
43
+
44
+ See [ Wiki Page] ( https://github.com/BruceZhang1993/index-generator/wiki )
45
+
46
+ ## License
47
+
48
+ [ MIT] ( https://github.com/BruceZhang1993/index-generator/blob/master/LICENSE )
49
+
50
+ ## Contributors
51
+ Sorting by alphabet order.
52
+ - Bruce Zhang ([ BruceZhang1993] ( https://github.com/BruceZhang1993 ) )
53
+ - Edward P ([ edward-p] ( https://github.com/edward-p ) )
54
+
55
+ [ More...] ( https://github.com/BruceZhang1993/index-generator/graphs/contributors )
You can’t perform that action at this time.
0 commit comments