FuturICT2 / FuturICT2/FIN4Simulations
Improve repository cosmetics
- Dominant language
- Jupyter Notebook
- Stars
- 7
- Forks
- 2
- PR merge metrics
- No merged PRs in 30d
Description
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](https://www.python.org/download/releases/3.0/)
- [ ] Readme: better formatting of code snippets using the \` syntax \`, like `pip3 install cadCAD`
Contributor guide
No contributing guide indexed for this repository
Research direction
Review the repository description and README against each checklist item, including the requested naming, headings, links, and code formatting. Done means the repository description and all listed README references and formatting improvements are addressed.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- Half a day
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100