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

Improve README #108

Open
jokroese opened this issue Nov 29, 2024 · 0 comments
Open

Improve README #108

jokroese opened this issue Nov 29, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@jokroese
Copy link
Member

We should have an inviting README!

I suggest we move a bunch of the technical start-up to a CONTRIBUTING.md file, and just include a getting started.

It would be great to have a screenshot of the map and some other nice parts.

Here are references for making nice READMEs.

@jokroese jokroese added the documentation Improvements or additions to documentation label Nov 29, 2024
@jokroese jokroese self-assigned this Nov 29, 2024
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

No branches or pull requests

1 participant