Skip to content

Commit fb5e3b6

Browse files
committed
updated readme
1 parent e1ced7a commit fb5e3b6

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

README.md

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,23 @@ Hands-on workshop material on Web scraping using Python 🛠️⚙️
44

55
### To build and run site locally :
66

7-
1. git clone https://github.com/MonashDataFluency/python-web-scraping.git
8-
2. cd python-web-scraping
9-
3. virtualenv -p python3 venv
10-
4. source venv/bin/activate
11-
5. pip install -r requirements.txt
12-
6. mkdocs serve
7+
Execute the following commands sequentially
138

14-
Note : `wptools` might throw an error during installtion, in which case install other dependencies as :
15-
- sudo apt install libcurl4-openssl-dev libssl-dev
9+
```bash
10+
git clone https://github.com/MonashDataFluency/python-web-scraping.git
11+
cd python-web-scraping
12+
virtualenv -p python3 venv
13+
source venv/bin/activate
14+
pip install -r requirements.txt
15+
mkdocs serve
16+
```
1617

17-
and then proceed to install `wptools` (included in step 5 above)
18-
19-
Note: After modifying any notebook content, please run the `./compile.sh` script to update the website or alternatively :
18+
After modifying any notebook content, please run the `./compile.sh` script to update the website or alternatively :
2019
- Run `jupyter nbconvert --output-dir='markdowns/' --to markdown notebooks/*.ipynb` from the root directory to generate the markdown files from jupyter notebooks, and
21-
- Run `mkdocs build` to generate the build the website again.
20+
- Run `mkdocs build` to generate the build the website again.
21+
22+
> Note : `wptools` might throw an error during installtion, in which case install other dependencies as :
23+
```bash
24+
sudo apt install libcurl4-openssl-dev libssl-dev
25+
```
26+
and then proceed to install `wptools` (included in step 5 above)

0 commit comments

Comments
 (0)