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

Update docs #502

Merged
merged 6 commits into from Jan 15, 2024
Merged

Update docs #502

merged 6 commits into from Jan 15, 2024

Conversation

blapie
Copy link
Collaborator

@blapie blapie commented Jan 11, 2024

General documentation update. Updating old and removing redundant information.
This is a first step towards moving doc from html to github-hosted markdown.

Open to suggestions for further updating README and docs in general.

Keep toolchain files and rename them.
Add a table for supported compilers and OS-es.
Add badges linked to CI, License and SLEEF paper, Spack package, ...
Update install and build instructions.
No need to maintain 2 changelogs.
Besides, the actual changelog is behind the one on the website.
Just keep CHANGELOG.md updated and remove the other one.
These can already be visualised in source or on github.
@blapie blapie added the doc label Jan 11, 2024
And minor fixes on README and website.
@blapie blapie merged commit 4deb9a8 into shibatch:master Jan 15, 2024
27 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant