Skip to content

Commit 741c035

Browse files
committed
Update read me with new install instructions
Describe the new branching model (develop and master)
1 parent 8494577 commit 741c035

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.rst

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,24 +11,33 @@ pygccxml is a specialized XML reader that reads the output from GCCXML. It provi
1111
Install
1212
-------
1313

14-
The package uses the Python distutils so you can do the usual procedure:
14+
You can use pip to install pygccxml:
1515

16-
python setup.py install
16+
pip install pygccxml
17+
18+
To install from source, you can use the usual procedure:
1719

18-
For more information about using the distutils see the Python manual
19-
"Installing Python Modules".
20+
python setup.py install
2021

2122
Contact us
2223
----------
2324

24-
You can contact us through the gccxml mailing list: http://www.gccxml.org/mailman/listinfo/gccxml .
25-
For issues with pygccxml you can open an issue here: https://github.com/gccxml/pygccxml/issues .
25+
You can contact us through the gccxml mailing list: http://www.gccxml.org/mailman/listinfo/gccxml
26+
27+
For issues with pygccxml you can open an issue here: https://github.com/gccxml/pygccxml/issues
2628

2729
Documentation
2830
-------------
2931

3032
For examples and tutorials see the documentation: http://gccxml.github.io/pygccxml/
3133

34+
Branches
35+
--------
36+
37+
The stable version can be found on the master branch.
38+
39+
The develop branch containes the latest improvements but can be unstable. Pull Requests should be done on the develop branch.
40+
3241
Testing and code coverage
3342
-------------------------
3443

0 commit comments

Comments
 (0)