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

Documentation: Main README.md content replaced with links to wiki #91

Closed
wants to merge 2 commits into from

Conversation

Gon-na
Copy link
Contributor

@Gon-na Gon-na commented Dec 11, 2023

This commit aims to streamline the README and wiki. For this puropse parts of the README have been replaced with links to the wiki and its chapter structure has been altered slightly.

This Commit reorders parts of the README and replaced a lot of content with links to the GitHub wiki with the goal to shorten the README and make it easier to keep information up to date.
@2xB
Copy link
Member

2xB commented Dec 13, 2023

Thanks for the Pull Request! While I think the deletions are great, I am not sure about the new insertions:

  • The new system requirements are probably already very outdated. Also they highly depend on what you simulate, so I think especially in a README that should be short and concise, that may not be that interesting.
  • Having the user guide as the first link in the README makes much sense, while the information that it uses HTML or that it is hosted by GitHub is not really interesting to the readers. So I would not move the user guide to a large section that uses such "filler information".
  • Having a dependency list in the README seems like unnecessary information and duplication of what the user manual contains already.

Maybe one can replace most of the README by just a collection of links like this from a different README?

image

Btw. I think going from "title case" to "sentence case" (like changing the title Open Source to Open source) is a question of personal style preference.

@Gon-na Gon-na closed this Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants