Skip to content

docs: enhance README by fixing grammar and adding beginner-friendly s… #1445

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anandvaidya21 wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −2
Open

docs: enhance README by fixing grammar and adding beginner-friendly s… #1445

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,17 @@ To contribute to the Streamlit library itself, see the [Streamlit library contri

To build the docs, clone this repo, install the NPM dependencies, and start the development server.

### Beginner Tips

- If the `make` command does not work, ensure that it is properly installed and available in your system's PATH.
- Verify that your Node.js and npm versions are compatible with the project requirements.
- After installing dependencies, restart your terminal to ensure all environment variables are correctly loaded.

### 1. Set up your base environment

Make sure you have [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) and `make` installed.
Ensure that both [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) and `make` are installed before proceeding.

#### Install `make` on MacOS
#### Install `make` on macOS

`make` is included with XCode Tools.

Expand Down