Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve README.md #91

Closed
czgdp1807 opened this issue Feb 20, 2020 · 3 comments
Closed

Improve README.md #91

czgdp1807 opened this issue Feb 20, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@czgdp1807
Copy link
Member

Description of the problem

The README of the project should be updated. We need to replace, Who are we? and How are we different? with an About section which should contain the following words,

Currently, the aim of the project is to be a Python package for various data structures in computer science. In addition, we are also working on including parallel algorithms. To the best of our knowledge there doesn't exist any well designed library/package which has covered most of the data structures and algorithms including their parallel implementation. 

In future, i.e, after a few releases of the package when the software design will become stable, we also aim to provide APIs for the code in C++ and Java as well. For clarity, the interested students aren't expected to know C++ and Java. Knowledge of Python is enough for this project.

Example of the problem

References/Other comments

@czgdp1807 czgdp1807 added documentation Improvements or additions to documentation beginner labels Feb 20, 2020
@yash2189
Copy link

Can I take this up as a contribution for gssoc'20?

@czgdp1807 czgdp1807 removed the gssoc20 label Feb 23, 2020
@czgdp1807
Copy link
Member Author

Hi, @yash2189
There is already a PR open for this. You can go for, #96.

@czgdp1807
Copy link
Member Author

Resolved by #93

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants