docs: expand README with project overview and getting started guide#45
Open
Noel24Dav wants to merge 1 commit intobos-com:mainfrom
Open
docs: expand README with project overview and getting started guide#45Noel24Dav wants to merge 1 commit intobos-com:mainfrom
Noel24Dav wants to merge 1 commit intobos-com:mainfrom
Conversation
… started guide The previous README contained only a single line with no useful information for contributors or new users. Changes made: - Added What is BOS section - Added Features section - Added Project Structure section - Added Getting Started with prerequisites and installation - Added Self Hosting section - Added Contributing guidelines - Added License and Contact sections Closes #<44>
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
1 participant
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.
What does this PR do?
Expands the README from a single line to a full project overview
with all essential sections for contributors and new users.
Changes made
Closes #<44>