Readme docs updates: pip, composer & sudo build.sh #115
Conversation
|
Any idea why my VSCodium edit of this would yield these result? |
README.md
Outdated
| - [PrivateRoute](#privateroute) | ||
| - [Deployment](#deployment) | ||
| - [Contributing](#contributing) | ||
| - [FastAPI + React · !build [](LICENSE) [](https://dependabot.com)](#fastapi--react--img-srchttpsgithubcombuuntufastapi-reactworkflowsbuildbadgesvg-altbuild-img-srchttpsimgshieldsiogithublicensepeaceirisactions-gh-pagessvg-altlicense-img-srchttpsimgshieldsiobadgedependabot-active-brightgreensvg-altdependabot-status) |
There was a problem hiding this comment.
This, features, and table of contents should not be a part of the TOC.
README.md
Outdated
| @@ -122,11 +132,11 @@ You will need to put in a few variables and it will create a project directory | |||
|
|
|||
| ## Develop | |||
|
|
|||
| Change into your project directory and run: | |||
| Change into your project directory and run as sudo priv (required for docker): | |||
There was a problem hiding this comment.
Run with elevated privileges is better.
README.md
Outdated
|
|
||
| ```bash | ||
| chmod +x scripts/build.sh | ||
| ./scripts/build.sh | ||
| sudo chmod +x scripts/build.sh |
There was a problem hiding this comment.
I don't think you need sudo for this, you might for docker-compose is all.
|
Okay, I have corrected the strange formatting caused a MD formatter for VS Code and removed the sudo for the build.sh Still got the prettier failed error, is that okay? Again, thank you so much for working with me on this. |
I think you need to setup Prettier in VSCode, it may not be running on the README. |
pip --> pip3 for more global install stability.
composer docs added for clarity
sudo build.sh ( this is necessary with the default docker setup )
:)