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

Improve repository cosmetics #7

Open
6 tasks
benjaminaaron opened this issue Apr 3, 2020 · 0 comments
Open
6 tasks

Improve repository cosmetics #7

benjaminaaron opened this issue Apr 3, 2020 · 0 comments

Comments

@benjaminaaron
Copy link
Member

Love the long Readme 👏

Suggestions for cosmetic improvements:

  • Add short description on top of Repo site (not in Readme)
  • Reference the FIN4Xplorer repos or the www.finfour.net side somewhere?
  • Readme: Name on top should be FIN4Simulations not FIN4Sim
  • Readme: Headings should be formatted in GitHub Markdown: #, ##, ###, ####
  • Readme: better formatting of links using the [ link name ] ( URL ) syntax, like python 3
  • Readme: better formatting of code snippets using the ` syntax `, like pip3 install cadCAD
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@benjaminaaron