Skip to content

Consolidate Readme - #173

Merged
s-poll merged 3 commits into
masterfrom
readmeC
Mar 15, 2023
Merged

s-poll merged 3 commits into
masterfrom
readmeC

Conversation

@s-poll

@s-poll s-poll commented Mar 8, 2023

Copy link
Copy Markdown
Member

I have consolidated the README file for improved readability to have only the most important information in the readme. I made use of shields.io icons for an overview of the documentation, release and commits. The remaining parts are put in the documentation.

@s-poll

s-poll commented Mar 8, 2023

Copy link
Copy Markdown
Member Author

Here you find the updated documentation: https://hpscterrsys.github.io/TSMP/readmeC/

@niklaswr niklaswr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Just checked your changes and left some somments.

Comment thread doc/content/introduction.md Outdated
Comment thread doc/content/introduction.md
Comment thread doc/content/gettingstarted.md
Comment thread doc/content/setup_examples.md

@DCaviedesV DCaviedesV left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Readme looks good to me.
The rest of the docs are progressing and still need some polishing I guess, but I understand the core of this PR is the README.

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.

3 participants