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.

Sign up for GitHub

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

Jump to bottom

Create a better Readme #91

Open
cereallarceny opened this issue May 19, 2020 · 1 comment
Open

Create a better Readme #91

cereallarceny opened this issue May 19, 2020 · 1 comment
Labels
Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase

Comments

@cereallarceny
Copy link
Member

Based on this readme template, we should improve our readmes across all OpenMined projects.

Please consult the following document for our desired best practices.
@cereallarceny cereallarceny added the Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase label May 19, 2020
@BhaswatiRoy
Copy link

Hello @cereallarceny
I can work on making the readme of the website repo better.
I was also thinking of adding a project structure in the readme like the following
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cereallarceny @BhaswatiRoy