Rewrite README: user-facing documentation#5
Open
YANGCHUNHONG3000 wants to merge 1 commit into
Open
Conversation
Author
|
Hey! Just wanted to add some context — I opened issue #6 to explain the thinking behind this PR. No pressure at all — if you like the direction I'm happy to iterate, if not, totally fine to close. Either way, cool project! 🏠 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current README is entirely a contributing guide — it opens with how to fork, clone, and set up a dev environment. But there's no project introduction, no installation guide, no entity list, no usage instructions. Users who land here have no idea what Indeklima does or how to get started.
This PR rewrites the README to be user-facing:
The existing CONTRIBUTING.md already covers the dev setup (which was duplicated in the old README), so this removes the duplication and keeps the README focused on users.