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

Use REAME.md as mainpage #674

Merged
merged 4 commits into from
Jan 10, 2023
Merged

Use REAME.md as mainpage #674

merged 4 commits into from
Jan 10, 2023

Conversation

ohm314
Copy link
Contributor

@ohm314 ohm314 commented Jan 4, 2023

Description

Just what the title of this PR says. The current mainpage is a useless stub, while the README.md is a nice overview of the project, so let's use that.

This improves on #222

tdegeus
tdegeus previously approved these changes Jan 7, 2023
pramodk
pramodk previously approved these changes Jan 9, 2023
@1uc
Copy link
Collaborator

1uc commented Jan 9, 2023

This section Examples contains multiple dead links, when used as part of the Doxygen documentation.

@ohm314 ohm314 dismissed stale reviews from pramodk and tdegeus via 757580d January 10, 2023 12:49
@ohm314
Copy link
Contributor Author

ohm314 commented Jan 10, 2023

@1uc , that should fix it.

Copy link
Collaborator

@1uc 1uc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice improvement over the previous starting page of the documentation!

@ohm314 ohm314 merged commit 4ad3555 into master Jan 10, 2023
@ohm314 ohm314 deleted the ohm314/readme_as_doxymainpage branch January 10, 2023 14:47
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.

None yet

4 participants