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

add README.md #39

Merged
merged 31 commits into from
Apr 17, 2024
Merged

add README.md #39

merged 31 commits into from
Apr 17, 2024

Conversation

arnaucube
Copy link
Collaborator

@arnaucube arnaucube commented Nov 28, 2023

PR to iterate the README.md to work on it and have it ready when Nova+CycleFold is ready.

@arnaucube arnaucube added the documentation Improvements or additions to documentation label Nov 28, 2023
@arnaucube arnaucube changed the title Initialize the README.md with a sketch of the structure [DRAFT PR] README.md Nov 28, 2023
@arnaucube arnaucube changed the title [DRAFT PR] README.md [draft PR] README.md Nov 28, 2023
@arnaucube arnaucube force-pushed the feature/readme branch 14 times, most recently from 771146e to 3de91b3 Compare March 21, 2024 09:10
@arnaucube arnaucube force-pushed the feature/readme branch 9 times, most recently from 616572e to 5aa7580 Compare March 27, 2024 16:42
- The License badge is not needed since there are already many links to
  the license both in the readme and in the GitHub UI
- The CI checks badge, already appears in the GitHub UI in the last
  commit preview at the main repo page. Furthermore, after some months
  of inactivity, the badge would be 'gray' as 'inactive'.
- The only badge that I was trying to get there is the 'docs' badge, to
  make it very clear that the docs page exists, but it was a bit to hard
  visually to have a single badge there, and furthermore the docs link
  already appears in the readme twice, and also in the GitHub UI
  right-panel.
@arnaucube arnaucube added this pull request to the merge queue Apr 17, 2024
Merged via the queue into main with commit 8b23303 Apr 17, 2024
5 checks passed
@arnaucube arnaucube deleted the feature/readme branch May 23, 2024 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants