Skip to content

Commit bb96ef5

Browse files
committed
feat: Add to homepage
1 parent 715c4bd commit bb96ef5

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

docs/README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,22 +24,37 @@ Also, the Tweepy library aims to be a _thin layer_ between your code and the Twi
2424

2525
So this website aims at making Tweepy and Twitter API easier to use. With additional support by linking to docs and Twitter policies.
2626

27+
Note that is guide was written main for Linux and macOS systems, to some commands will not work on Windows (in particular any shell commands).
28+
2729

2830
## Install Tweepy
2931

32+
If you are new to Python or virtual environments, read through this guide for more background on the instructions below - [Setup a Python 3 virtual environment](https://gist.github.com/MichaelCurrin/3a4d14ba1763b4d6a1884f56a01412b7)
33+
34+
35+
### System dependencies
36+
3037
Install [Python 3](python.org/)
3138

32-
Create a virtual environment, as it is recommended to install Python packages inside a virtual
33-
environment. Use the `venv` tool which built-in for Python 3.
39+
### Install project dependencies
3440

35-
```sh
41+
```bash
3642
cd my-project
43+
```
44+
45+
Create a virtual environment. Here we use the `venv` tool which built-in for Python 3, but you can use something else.
46+
47+
```bash
3748
python3 -m venv venv
38-
# Linux and macOS
49+
```
50+
51+
Activate the virtual environment.
52+
53+
```bash
3954
source venv/bin/activate
4055
```
4156

42-
Install Tweepy in the virtual environment.
57+
Install Tweepy into the virtual environment.
4358

4459
```sh
4560
pip install tweepy

0 commit comments

Comments
 (0)