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

Need to write README.MD for this repo. #4

Open
prastut opened this issue Sep 24, 2016 · 8 comments
Open

Need to write README.MD for this repo. #4

prastut opened this issue Sep 24, 2016 · 8 comments

Comments

@prastut
Copy link
Member

prastut commented Sep 24, 2016

https://github.com/Cambuzz/cambuzz-android-client

@prastut
Copy link
Member Author

prastut commented Sep 24, 2016

Process yeh hoga.

@shantanutrip start with initial run. Ek basic structure khada karde. This is also help you in gaining insights in Cambuzz for interview purposes.

@patelfenil moderate for backend stack.
I will moderate for frontend.

@prasang7 review process will be handled by you.

@prastut
Copy link
Member Author

prastut commented Sep 24, 2016

Stipulated work:

  • Brief + Motivation.
  • Tech stack.
  • How to setup code.

Follow the structure from here: https://github.com/prastut/teem

@prastut
Copy link
Member Author

prastut commented Sep 24, 2016

@shantanutrip https://github.com/Cambuzz/core/blob/master/README.md

You can edit the file inside Github only. Click on the pencil icon.

@prastut
Copy link
Member Author

prastut commented Sep 29, 2016

@shantanutrip what's the progress on this? Developers are starting to notice the repo and they can't setup the codebase.

@patelfenil please collaborate with him.

@mashrin we will keep you posted.

@prastut
Copy link
Member Author

prastut commented Sep 29, 2016

I really like how they have done their README. You guys can directly take inspiration from here:
https://github.com/discourse/discourse/blob/master/README.md

@shantanutrip
Copy link
Contributor

shantanutrip commented Oct 1, 2016

@prastut , I saw the README link. Its good. I will have to collaborate with @patelfenil to carry out the snapshot part. Otherwise snapshots are not required as it is a simple process and easy to follow. Only the content has to be arranged.

@prastut
Copy link
Member Author

prastut commented Oct 1, 2016

@shantanutrip not really care for the snapshot part and completely agree with your perspective.

  • Don't need snapshots

I really like how they have segmented content eg Installation has been moved to another readme so as to not clutter the value proposition of the product. This is what we can do here also.

@prastut
Copy link
Member Author

prastut commented Oct 1, 2016

@shantanutrip I am providing you with a checklist. Feel free to change or remove or not even follow:

  • Cambuzz Logo. You can take it from @prasang7.
  • About Cambuzz. Explanation from website can be taken as what is Cambuzz trying to do.
  • Setting up Cambuzz. Move installation to another readme.
  • Built with (Tech Stack)
  • Contributing. This should have a Gitter badge from Gitter Channel #7 .
  • Cambuzz Team. Move to another readme. Provide Github links.
  • License. Just write MIT. Move the LICENSE to another LICENSE.MD where cut -> paste the content.
  • Dedication. This paragraph should answer what are we exactly trying to solve. Content is on Cambuzz WhatsApp group, can take directly from there.

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

No branches or pull requests

4 participants