Skip to content

Improve Readme #374

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

Closed
dynamitechetan opened this issue Oct 1, 2018 · 13 comments
Closed

Improve Readme #374

dynamitechetan opened this issue Oct 1, 2018 · 13 comments
Labels
enhancement This PR modified some existing files good first issue hacktoberfest merge conflicts Open a new PR or rebase on the latest commit

Comments

@dynamitechetan
Copy link
Member

Many new algorithms were added. The readme file can be updated with those new algorithms.
https://github.com/TheAlgorithms/Python/blob/master/README.md

@dynamitechetan dynamitechetan added enhancement This PR modified some existing files merge conflicts Open a new PR or rebase on the latest commit hacktoberfest good first issue labels Oct 1, 2018
@vldmrkl
Copy link
Contributor

vldmrkl commented Oct 1, 2018

I would like to add descriptions for:

  • Bucket sort
  • Cocktail shaker sort
  • Radix sort
  • Topological sort

Let me know if it is ok.

@harshildarji
Copy link
Member

Hello @klymenkoo,
Your contributions to improving Readme is highly welcomed.
Thank you.

@Gekk0r
Copy link

Gekk0r commented Oct 2, 2018

Hello :),

I would like to add description for these:

  • pankace
  • gnome
  • tree
  • cycle

@AnupKumarPanwar
Copy link
Member

We don't want a single README file having all the algorithms. Create individual readme files for every algorithm in this repo. See the sample readme.md file and try to keep the same format as far as possible.

@Gekk0r
Copy link

Gekk0r commented Oct 2, 2018 via email

@vldmrkl
Copy link
Contributor

vldmrkl commented Oct 2, 2018

We don't want a single README file having all the algorithms. Create individual readme files for every algorithm in this repo. See the sample readme.md file and try to keep the same format as far as possible.

@AnupKumarPanwar it seems to be another big issue as it means restructuring the whole project.

@JRaidn
Copy link

JRaidn commented Oct 2, 2018

So... Where I put the README files of the algorithms I added to the project?

@AlexDvorak
Copy link
Contributor

I could split up the main readme into smaller readmes for each subfolder. and i could make the main readme link to each of those. is that fine or are there other concerns?

@HopeTS
Copy link
Contributor

HopeTS commented Oct 21, 2018

If you look at Pull request #488 I fixed the README entirely. Everything is formatted properly now.

@emmafritx
Copy link

.

@EternalLearner42
Copy link

Greetings. Can this still be considered open? I have some ideas on improving the README (adding images to some of the algorithms, fixing typos, ...) and would like to know if I am free to go.

@wizzup
Copy link

wizzup commented May 24, 2019

I think each directory should contain a separate README file so when browsing the repo on github it will render the README as directory summary instead of list of files.

@JRaidn
Copy link

JRaidn commented May 24, 2019 via email

@cclauss cclauss closed this as completed Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This PR modified some existing files good first issue hacktoberfest merge conflicts Open a new PR or rebase on the latest commit
Projects
None yet
Development

No branches or pull requests