Skip to content

Commit 35a3763

Browse files
Update README.md (#1304)
* Update README.md * Disable anonymized user tracking in Kapa * Include make as a dependency in README --------- Co-authored-by: Debbie Matthews <debbie.matthews@snowflake.com>
1 parent df07f17 commit 35a3763

File tree

2 files changed

+14
-80
lines changed

2 files changed

+14
-80
lines changed

README.md

Lines changed: 13 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -10,91 +10,24 @@ To build the docs, clone this repo, install the NPM dependencies, and start the
1010

1111
### 1. Set up your base environment
1212

13-
#### MacOS
13+
Make sure you have [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) and `make` installed.
1414

15-
```bash
16-
# Some Apple dev tools (developer.apple.com/downloads)
17-
$ xcode-select --install
18-
19-
# Install Homebrew
20-
$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
21-
22-
# Install the Protobuf compiler, graphviz, database, and virtual environment
23-
$ brew install protobuf graphviz gawk mysql mysql-client pkg-config unixodbc postgresql pre-commit
24-
```
25-
26-
**Installing Node JS and yarn**
27-
28-
We recommend that you [manage your nodejs installation with nvm](https://github.com/nvm-sh/nvm#install--update-script).
29-
After following the instructions linked above to install `nvm`, use the following command to install the latest supported node version
30-
31-
```bash
32-
# Install node
33-
nvm install node
34-
```
15+
#### Install `make` on MacOS
3516

36-
**Note:** Node has added Corepack which is a manager of package managers 😱. It supports yarn! You can enable it by running the following:
37-
38-
```bash
39-
corepack enable
40-
```
41-
42-
You may need to `brew install corepack` depending on how you installed node.
43-
44-
**ARM based Macs**
45-
46-
If you are running a MacOS computer running on the new chipsets (e.g. M1), you may hit some trouble installing pyodbc This can be solved by installing `unixodbc` and setting some flags. See [this comment](https://github.com/mkleehammer/pyodbc/issues/846#issuecomment-816166371) for help. We found that it just needs to be set once. Be sure to make sure you have the correct version of unixodbc in the commands.
47-
48-
#### Ubuntu
49-
50-
```bash
17+
`make` is included with XCode Tools.
5118

52-
# Set up the Yarn repo
53-
$ curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
54-
$ echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
19+
- In your terminal, run the following command:
20+
```bash
21+
$ xcode-select --install
22+
```
5523

56-
$ sudo apt-get update
24+
#### Install `make` on Windows
5725

58-
# Install Pyenv for testing multiple Python versions
59-
$ sudo apt install -y make build-essential libssl-dev zlib1g-dev libbz2-dev \
60-
libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev \
61-
xz-utils tk-dev libffi-dev liblzma-dev python-openssl mysql-client libmysqlclient-dev unixodbc-dev
62-
$ curl -L https://github.com/pyenv/pyenv-installer/raw/master/bin/pyenv-installer | bash
63-
64-
# Install some other deps
65-
$ sudo apt install graphviz python3-distutils pre-commit
66-
67-
# Install Yarn, pip, Protobuf, npm
68-
$ sudo apt install yarn npm python-pip protobuf-compiler libgconf-2-4
69-
# (libgconf is for our e2e tests in Cypress)
70-
71-
```
72-
73-
Probably not needed, but in case you want to update your Node installation:
74-
75-
```bash
76-
curl -sL https://deb.nodesource.com/setup_10.x | sudo -E bash -
77-
```
78-
79-
#### Windows
80-
81-
Streamlit's development setup is pretty Mac- and Linux-centric. If you're doing Streamlit development on Windows, we suggest spinning up a Linux VM (you can do this easily with [VirtualBox](https://www.virtualbox.org/), which is free); or working in a Linux Docker image.
82-
83-
Alternately, you can try using Microsoft's WSL ("Windows Subsystem for Linux"), which may work fine, or may result in you slowly dying from thousands of tiny papercuts (these steps were last tested on 2019-11-18):
84-
85-
- [Install WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10), using the Ubuntu image from the Microsoft Store
86-
- [Make sure your WSL supports chmod/chown](https://devblogs.microsoft.com/commandline/chmod-chown-wsl-improvements/).
87-
- [Make sure you have pre-commit installed and it is available on your path](https://pre-commit.com/#install).
88-
- If you have Windows versions of Streamlit build dependencies installed (e.g. Python, nodejs), you may want to consider removing the Windows path from your Linux $PATH, to prevent conflicts.
89-
- [See the WSL Release Notes](https://docs.microsoft.com/en-us/windows/wsl/release-notes#build-17713) for instructions on editing your wsl.conf file. You'll want to set `appendWindowsPath=false`.
90-
- Follow the [Ubuntu setup instructions above](#Ubuntu), with the following modifications:
91-
92-
```bash
93-
# Install a Python version using pyenv with the `CONFIGURE_OPTS=--enable-shared` flag set:
94-
$ CONFIGURE_OPTS=--enable-shared pyenv install 3.7.5 && pyenv global 3.7.5
95-
96-
$ python -m venv venv
97-
```
26+
1. [Install Chocolately](https://chocolatey.org/install), a package manager for Windows.
27+
2. In your terminal, run the following command:
28+
```bash
29+
choco install make
30+
```
9831

9932
### 2. Clone this repo:
10033

components/utilities/kapa.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,7 @@ const Kapa = () => {
5858
data-modal-border-radius="6px"
5959
data-modal-image-height="18px"
6060
data-answer-feedback-button-active-border="1px solid #808495"
61+
data-user-analytics-cookie-enabled="false"
6162
></script>
6263
</section>
6364
</div>

0 commit comments

Comments
 (0)