Skip to content

docs: Update README #744

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

Merged
merged 1 commit into from
Jul 20, 2024
Merged

docs: Update README #744

merged 1 commit into from
Jul 20, 2024

Conversation

alessfg
Copy link
Member

@alessfg alessfg commented Jul 19, 2024

Proposed changes

This PR updates the README. In order to make the installation instructions easier, some file names used by the various GitHub Actions workflows have been renamed. As a small bonus, some other docs have had their **Note:** sections updated to use GitHub markdown alerts.

Checklist

Before creating a PR, run through this checklist and mark each as complete:

@alessfg alessfg self-assigned this Jul 19, 2024
@github-actions github-actions bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation labels Jul 19, 2024
@alessfg alessfg removed the dependencies Pull requests that update a dependency file label Jul 19, 2024
@alessfg alessfg added this to the 0.25.0 milestone Jul 19, 2024
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Jul 20, 2024
@alessfg alessfg removed the dependencies Pull requests that update a dependency file label Jul 20, 2024
@alessfg alessfg merged commit 02a9ee6 into main Jul 20, 2024
18 checks passed
@alessfg alessfg deleted the update-readme branch July 20, 2024 17:39
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.

1 participant