docs: add root README with repository layout and setup guide - #484
Open
profitegood wants to merge 1 commit into
Open
docs: add root README with repository layout and setup guide#484profitegood wants to merge 1 commit into
profitegood wants to merge 1 commit into
Conversation
Author
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.
What type of PR is this?
docsSummary
Adds a root-level
README.mdthat GitHub renders on the repository home page.Documents the purpose of every top-level file and directory, prerequisites,
and step-by-step setup and run instructions. Closes #<номер issue>.
How to test
README.mdon the PR's "Files changed" tab and verify Markdown renders correctly../docs/architecture.md, etc.) resolve.