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

Improved README.md #93

Merged
merged 4 commits into from
Feb 24, 2020
Merged

Improved README.md #93

merged 4 commits into from
Feb 24, 2020

Conversation

Jprillaman
Copy link
Contributor

References to other Issues or PRs or Relevant literature

Brief description of what is fixed or changed

Replaced Who are we? and How are we different? with an About section with: "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."

Other comments

Replaced Who are we? and How are we different? with a new About section containing 
"
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.
"
@codecov
Copy link

codecov bot commented Feb 22, 2020

Codecov Report

Merging #93 into master will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##            master       #93   +/-   ##
=========================================
  Coverage   97.273%   97.273%           
=========================================
  Files           32        32           
  Lines         1797      1797           
=========================================
  Hits          1748      1748           
  Misses          49        49

Impacted file tree graph

@czgdp1807
Copy link
Member

@Jprillaman Thanks for your contributions. Are you participating through GSSoC 2020?

@czgdp1807 czgdp1807 added the documentation Improvements or additions to documentation label Feb 23, 2020
@Jprillaman
Copy link
Contributor Author

Jprillaman commented Feb 23, 2020

@czgdp1807 No I'm not. I hope that isn't a problem. I've just started learning how to use Github

@czgdp1807
Copy link
Member

czgdp1807 commented Feb 23, 2020

@Jprillaman No problems at all. Actually, we have a separate label for their participants to track their progress.

README.md Outdated Show resolved Hide resolved
Removed "For clarity, the interested students aren't expected to know C++ and Java. Knowledge of Python is enough for this project."
@czgdp1807
Copy link
Member

Thanks. Merging.

@czgdp1807 czgdp1807 merged commit f16ce90 into codezonediitj:master Feb 24, 2020
@czgdp1807 czgdp1807 mentioned this pull request Feb 24, 2020
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

Successfully merging this pull request may close these issues.

2 participants