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 readme #540

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Update readme #540

wants to merge 2 commits into from

Conversation

SO9010
Copy link
Contributor

@SO9010 SO9010 commented Oct 11, 2024

This is my start to updating the readme.md.

I'm using this template: https://github.com/othneildrew/Best-README-Template/blob/main/README.md

Still need to add info that is on readme now, add hot to create kiosk mode, add roadmap.

Add conventions.
@jacksongoode
Copy link
Collaborator

I could be persuaded but I don't think the current readme layout and organization is bad. Maybe we can add some of the features to it but I don't think it needs to be completely reorganized?

@jacksongoode
Copy link
Collaborator

I think we could some badges that will indicate stars or forks or contributors, but that doesn't seem completely necessary.

We'll definitely need updated screenshots since the application has changed. And the building and roadmap need total refactors just to make sure that we can style them a bit better. Maybe the basic project structure could also be put just within the building section.

@SO9010
Copy link
Contributor Author

SO9010 commented Oct 16, 2024

Ok, cool. Thank you for the feedback, and yes, thinking about it, the current layout is better; we just need to discuss what we want on the roadmap. We probably want multiple opinions on this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants