Skip to content

Add Readme.md #1

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

Open
nimit2801 opened this issue Mar 12, 2021 · 9 comments
Open

Add Readme.md #1

nimit2801 opened this issue Mar 12, 2021 · 9 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@nimit2801
Copy link
Member

Please add a Readme.md to this repository.

All contributors are welcomed.

@nimit2801 nimit2801 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Mar 12, 2021
@Ckrielle
Copy link

Hello there I would be interested to work on this. Do you just want me to add the README to the repo, or write something in it? If so do you want it to have anything specific (e.g. specific format, specific description), or just a general simple description of the repo?

@nimit2801
Copy link
Member Author

Hey @Ckrielle, welcome.
We would have a general Readme explaining the project and its working.
This project is inspired by Python Workout By Reuven M. Lerner
It will have 50 projects from this book.
Also, you can some additional information on how to install python, min requirements, etc.

I hope this answers your question.

@Ckrielle
Copy link

Ckrielle commented Mar 14, 2021

@nimit2801 Ok, thanks for the clarifications

@nimit2801
Copy link
Member Author

nimit2801 commented Mar 14, 2021

Welcome @Ckrielle would wait for your cool, PR!
Assigning this issue to you :)

@nimit2801
Copy link
Member Author

The issue is still open for contributions! 🍡

This was referenced Apr 13, 2021
@nimit2801
Copy link
Member Author

Thanks for updating the README,
but @abirbhattacharya82 few points I would like to suggest:

  1. Please don't use headers for sentences like Code: Code1.
  2. I would suggest not to link Code and output, instead, you can just give a quick summary for all programs and a little about why this project is being made!

Now that we have a starting point for the README, I hope we can improve it a lot!

I hope @Veershah26 can elaborate more on this!

@abirbhattacharya82
Copy link
Contributor

One thing can be done then, we can make a table or something like that where we can add the links to the codes and their respective outputs. Something like this:

Question No Program Output
1 Solution Output
27 Solution Output

See this and tell me then I will go ahead with it.

@nimit2801
Copy link
Member Author

This seems to be a good idea @abirbhattacharya82
Feel free to make a PR.

ps: Sorry for the late reply

@abirbhattacharya82
Copy link
Contributor

I have created a PR review it and tell me if any changes are required

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants