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

Rework the main Readme #491

Merged
merged 6 commits into from
Apr 15, 2024
Merged

Rework the main Readme #491

merged 6 commits into from
Apr 15, 2024

Conversation

MGaetan89
Copy link
Member

@MGaetan89 MGaetan89 commented Apr 8, 2024

Pull request

Description

This PR updates the main Readme file.

Changes made

  • All badges are now from shields.io to have a consistent display.
  • Provide an overview of Pillarbox's features.
  • Add a section about the demo applications.
  • Add a link to GitHub's documentation about adding a repository.
  • Add links to each Pillarbox modules documentation.

Checklist

  • Your branch has been rebased onto the main branch.
  • APIs have been properly documented (if relevant).
  • The documentation has been updated (if relevant).
  • New unit tests have been written (if relevant).
  • The demo has been updated (if relevant).
  • All pull request status checks pass.

@MGaetan89 MGaetan89 requested review from Loic-Dumas and StaehliJ April 8, 2024 19:54
@MGaetan89 MGaetan89 linked an issue Apr 8, 2024 that may be closed by this pull request
2 tasks
Copy link

github-actions bot commented Apr 8, 2024

Code Coverage

Overall Project 46.59% 🟢

There is no coverage information present for the Files changed

@MGaetan89 MGaetan89 self-assigned this Apr 9, 2024
@MGaetan89 MGaetan89 force-pushed the 438-improve-readme-to-build-project branch from 47b4c40 to d5518aa Compare April 10, 2024 11:54
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Outdated Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
docs/README.md Show resolved Hide resolved
@MGaetan89 MGaetan89 force-pushed the 438-improve-readme-to-build-project branch from d5518aa to 6a5679a Compare April 11, 2024 12:05
@StaehliJ StaehliJ added this pull request to the merge queue Apr 15, 2024
Merged via the queue into main with commit d541a71 Apr 15, 2024
10 checks passed
@StaehliJ StaehliJ deleted the 438-improve-readme-to-build-project branch April 15, 2024 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Improve Readme to build project
3 participants