This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
Update Format of README Section #681
Merged
Conversation
This file contains 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
…ADME seemed like it was supposed to format this step into two different sections, one for users running CouchDB 1.x and one for 2.x. However, I think that no line break occurred that differentiated the part IV main line from the sub-instructions, and made the section a little bit confusing to read.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
No previous issue about this pull request
I just started looking at this project and while I was going through the install section I was a little bit confused by the formatting of the Create Admin User section of the Install section in the README.
I am sorry that I didn't make an official issue prior to this, but it is a pretty minor change that I just wanted to add in to make the README a little bit clearer for new users.
Proposed Changes
Change format of part IV of step 6 from this:
to this:
cc @HospitalRun/core-maintainers
Changed README.md at part IV in step 6 of the Install section. The README seemed like it was supposed to format this step into two different sections, one for users running CouchDB 1.x and one for 2.x. However, I think that no line break occurred that differentiated the part IV main line from the sub-instructions, and made the section a little bit confusing to read.