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

Restructure README.md #460

Closed
Parikshit-Hooda opened this issue Oct 25, 2019 · 1 comment · Fixed by #835
Closed

Restructure README.md #460

Parikshit-Hooda opened this issue Oct 25, 2019 · 1 comment · Fixed by #835
Labels
no issue activity

Comments

@Parikshit-Hooda
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Restructure README.md for visitors to easily follow.

Describe the solution you'd like
Some content can be moved to more relevant locations and links to them can be added to the README.md

Describe alternatives you've considered

  • Move Contributors section in the README.md to CONTRIBUTING.md, perhaps.
  • Put 'Additional setup instructions for Ubuntu' under the SETUP section as subheading or extension rather than a separate topic itself.
  • Other restructure requests may follow as comments on this issue. To discuss further, join our slack.

Additional context
Intended to be solved under Google Code-in 2019.

Are you working on this? (Yes/No)
No
JoshHeng added a commit to JoshHeng/CircuitVerse that referenced this issue Jan 20, 2020
@JoshHeng
Update README to make it more readable (Fixes CircuitVerse#460)
4d726f5 
The README has been restructured and edited to make it simpler to understand. Information has also been transferred to the CONTRIBUTING and SETUP files to retain simplicity.
@JoshHeng JoshHeng mentioned this issue Jan 20, 2020
Merged
JoshHeng added a commit to JoshHeng/CircuitVerse that referenced this issue Jan 20, 2020
@JoshHeng
Update README to make it more readable (Fixes CircuitVerse#460)
baabdd6 
The README has been restructured and edited to make it simpler to understand. Information has also been transferred to the CONTRIBUTING and SETUP files to retain simplicity.
JoshHeng added a commit to JoshHeng/CircuitVerse that referenced this issue Jan 20, 2020
@JoshHeng
Update README to make it more readable (Fixes CircuitVerse#460)
5cb9b19 
The README has been restructured and edited to make it simpler to understand. Information has also been transferred to the CONTRIBUTING and SETUP files to retain simplicity.
JoshHeng added a commit to JoshHeng/CircuitVerse that referenced this issue Jan 23, 2020
@JoshHeng
Update README to make it more readable (Fixes CircuitVerse#460)
61892b1 
The README has been restructured and edited to make it simpler to understand. Information has also been transferred to the CONTRIBUTING and SETUP files to retain simplicity.
@github-actions
Copy link

Stale issue message

satu0king added a commit that referenced this issue Mar 2, 2020
@JoshHeng @satu0king
Update README to make it more readable (Fixes #460) (#835)
2fadf1f 
* Update README to make it more readable (Fixes #460)

The README has been restructured and edited to make it simpler to understand. Information has also been transferred to the CONTRIBUTING and SETUP files to retain simplicity.

* Make README badges rectangular and with relevant logos

* Update SETUP.md

Update instructions for configuring third party services

Co-authored-by: Satvik Ramaprasad <satviksr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
no issue activity
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update README to make it more readable (Fixes #460) JoshHeng/CircuitVerse
1 participant
@Parikshit-Hooda