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

docs: update README #335

Merged
merged 2 commits into from
Dec 19, 2024
Merged

docs: update README #335

merged 2 commits into from
Dec 19, 2024

Conversation

MaelImhof
Copy link
Contributor

Summary

This PR updates the README file of the repository to welcome new visitors appropriately, present the app in all its beauty and explain how the repository works.

I also updated the wiki in the same movement, you might want to take at that as well. I'll just have to change the build action link once the APK has been built and is ready for grading.

@MaelImhof MaelImhof added the documentation Improvements or additions to documentation label Dec 19, 2024
@MaelImhof MaelImhof added this to the Milestone 3 milestone Dec 19, 2024
@MaelImhof MaelImhof self-assigned this Dec 19, 2024
@MaelImhof MaelImhof linked an issue Dec 19, 2024 that may be closed by this pull request
Copy link

Code Coverage

Overall Project 89.59% 🍏

There is no coverage information present for the Files changed

@davidholzwarth davidholzwarth added the Sprint 10 Active during the dixième sprint label Dec 19, 2024
Copy link
Contributor

@davidholzwarth davidholzwarth left a comment

Choose a reason for hiding this comment

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

Thanks, this is great. I am a little worried about the release version, but other than that I love it.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@davidholzwarth
Copy link
Contributor

davidholzwarth commented Dec 19, 2024

I checked the wiki too. Just one comment, otherwise its good.

Copy link
Contributor

@rBergCode rBergCode left a comment

Choose a reason for hiding this comment

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

Thanks!

@rBergCode rBergCode merged commit 470bf45 into main Dec 19, 2024
4 checks passed
@rBergCode rBergCode deleted the docs/readme branch December 19, 2024 23:12
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 Sprint 10 Active during the dixième sprint
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update ReadMe
3 participants