Skip to content

Commit 92c73a4

Browse files
Improved README (#481)
1 parent f85671b commit 92c73a4

File tree

1 file changed

+23
-17
lines changed

1 file changed

+23
-17
lines changed

README.md

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,18 @@ PyDataStructs
66
About
77
-----
88

9-
This project aims to be a Python package for various data structures in computer science. We are also working on the development of algorithms including their parallel implementations. To the best of our knowledge, a well-designed library/package which has covered most of the data structures and algorithms including their parallel implementation doesn't exist yet.
9+
- **PyDataStructs** project aims to be a Python package for various data structures and algorithms (including their parallel implementations).
1010

11-
Once the software design becomes more stable after a few releases of this package in the near future, we also aim to provide APIs for the code in C++ and Java as well.
11+
- We are also working on providing C++ backend via Python C-API for high performance use cases.
12+
13+
Why PyDataStructs?
14+
-------------------
15+
16+
- **Single package for all your data structures and algorithms**
17+
18+
- **Consistent and Clean Interface** - The APIs we have provided are consistent with each other, clean and easy to use. We make sure of that before adding any new data structure or algorithm.
19+
20+
- **Well Tested** - We thoroughly test our code before making any new addition to PyDataStructs. 99 percent lines of our code have already been tested by us.
1221

1322
Installation
1423
------------
@@ -43,23 +52,29 @@ For testing your patch locally follow the steps given below,
4352
2. Run, `python3 -m pytest --doctest-modules --cov=./ --cov-report=html`. Look for, `htmlcov/index.html` and open it in your browser, which will show the coverage report. Try to ensure that the coverage is not decreasing by more than 1% for your patch.
4453

4554
For a good visualisation of the different data structures and algorithms, refer the following websites:
46-
- https://visualgo.net/
47-
- https://www.cs.usfca.edu/~galles/visualization/
55+
56+
- <https://visualgo.net/>
57+
- <https://www.cs.usfca.edu/~galles/visualization/>
4858

4959
You can use the examples given in the following book as tests for your code:
60+
5061
- [https://opendatastructures.org/ods-python.pdf](https://opendatastructures.org/ods-python.pdf)
5162

5263
Why do we use Python?
5364
------------------
5465

55-
As we know Python is an interpreted language and hence is slow compared to C++, the most popular language for competitive programming. We still decided to use Python because the software development can happen at a much faster pace and it is much easier to test various software designs and APIs as coding them out takes no time. However, keeping the need of the users in mind, we will shift to C++ backend, which will happen quickly as we would be required to just translate the tested code rather than writing it from scratch, after a few releases with APIs available for all the languages.
66+
- As we know Python is an interpreted language and hence executing programs in it is slower as compared to C++.
67+
68+
- We still decided to use Python because the software development can happen at a much faster pace and it is much easier to test various software designs and APIs as coding them out takes no time in Python.
69+
70+
- However, keeping the need of the users in mind, we are also working on providing a C++ backend, which will happen quickly as we would be required to just translate the tested code rather than writing it from scratch.
5671

5772
How to contribute?
5873
------------------
5974

6075
Follow the steps given below,
6176

62-
1. Fork, https://github.com/codezonediitj/pydatastructs/
77+
1. Fork, <https://github.com/codezonediitj/pydatastructs/>
6378
2. Execute, `git clone https://github.com/codezonediitj/pydatastructs/`
6479
3. Change your working directory to `../pydatastructs`.
6580
4. Execute, `git remote add origin_user https://github.com/<your-github-username>/pydatastructs/`
@@ -81,11 +96,10 @@ It is recommended to go through the following links before you start working.
8196
- [Pull Request Policy](https://github.com/codezonediitj/pydatastructs/wiki/Pull-Request-Policy)
8297
- [Plan of Action for the Projects](https://github.com/codezonediitj/pydatastructs/wiki/Plan-of-Action-for-the-Projects)
8398

84-
8599
Guidelines
86100
----------
87101

88-
We recommend you to join our [gitter channel](https://gitter.im/codezoned2017/Lobby) for discussing anything related to the project.
102+
We recommend you to join our [discord channel](https://discord.gg/PwY7wQDG5G) for discussing anything related to the project.
89103

90104
Please follow the rules and guidelines given below,
91105

@@ -107,12 +121,4 @@ Keep contributing!!
107121

108122
Thanks to these wonderful people ✨✨:
109123

110-
<table>
111-
<tr>
112-
<td>
113-
<a href="https://github.com/codezonediitj/pydatastructs/graphs/contributors">
114-
<img src="https://contrib.rocks/image?repo=codezonediitj/pydatastructs" />
115-
</a>
116-
</td>
117-
</tr>
118-
</table>
124+
![https://github.com/codezonediitj/pydatastructs/graphs/contributors](https://contrib.rocks/image?repo=codezonediitj/pydatastructs)

0 commit comments

Comments
 (0)