Skip to content

Commit f5e75e5

Browse files
authored
Update README.md
The previous README showed headers with hashtags appended to the left of the header. I think that they are typos and the idea was to use the features of markdown to present a well formatted README. Also, the commands were not annotated properly (considering the markdown standards), disabling the opportunity to use the features of the markdown parser of github to display a button to copy/paste easily at the sides of each command. The changes made address the problems mentioned above.
1 parent 3fba6b9 commit f5e75e5

File tree

1 file changed

+40
-40
lines changed

1 file changed

+40
-40
lines changed

README.md

Lines changed: 40 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
#[Programming Bitcoin](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/)
1+
# [Programming Bitcoin](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/)
22

3-
###BY[ JIMMY SONG](https://github.com/jimmysong)
3+
### BY[ JIMMY SONG](https://github.com/jimmysong)
44

5-
#####[O'Reilly Media, Inc.March 2019](https://learning.oreilly.com/library/publisher/oreilly-media-inc/)
5+
##### [O'Reilly Media, Inc.March 2019](https://learning.oreilly.com/library/publisher/oreilly-media-inc/)
66

77
# LICENSE
88

@@ -11,72 +11,72 @@ Repository for the book to be published by O'Reilly.
1111
This book will be licensed under [CC-BY-NC-ND](https://creativecommons.org/licenses/by-nc-nd/4.0/legalcode) once the book is published.
1212

1313

14-
##Setting Up
14+
## Setting Up
1515

1616

1717
To get the most out of this book, you’ll want to create an environment where you can run the example code and do the exercises. Here are the steps required to set everything up:
1818

19-
###1. Install Python 3.5 or higher on your machine:
19+
### 1. Install Python 3.5 or higher on your machine:
2020

2121
Windows:
22-
[https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64.exe
23-
](https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64.exe
24-
)
22+
[https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64.exe](https://www.python.org/ftp/python/3.6.2/python-3.6.2-amd64.exe)
2523

2624
macOS:
2725
[https://www.python.org/ftp/python/3.6.2/python-3.6.2-macosx10.6.pkg](https://www.python.org/ftp/python/3.6.2/python-3.6.2-macosx10.6.pkg)
2826

2927
Linux
30-
#####See your distro docs (many Linux distributions, like Ubuntu, come with Python 3.5+ preinstalled)
28+
##### See your distro docs (many Linux distributions, like Ubuntu, come with Python 3.5+ preinstalled)
3129

32-
###2. Install pip by downloading this script: [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py).
30+
### 2. Install pip by downloading this script: [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py).
3331

34-
###3. Run this script using Python 3:
32+
### 3. Run this script using Python 3:
3533

36-
`$ python3 get-pip.py`
34+
```sh
35+
python3 get-pip.py
36+
```
3737

38-
###4. Install Git. The commands for downloading and installing it are at [https://git-scm.com/downloads](https://git-scm.com/downloads).
38+
### 4. Install Git. The commands for downloading and installing it are at [https://git-scm.com/downloads](https://git-scm.com/downloads).
3939

40-
###5. Download the source code for this book:
40+
### 5. Download the source code for this book:
4141

42-
`$ git clone https://github.com/jimmysong/programmingbitcoin`
43-
`$ cd programmingbitcoin`
42+
```sh
43+
git clone https://github.com/jimmysong/programmingbitcoin
44+
cd programmingbitcoin
45+
```
4446
45-
###6. Install virtualenv:
47+
### 6. Install virtualenv:
4648

47-
`$ pip install virtualenv`
49+
```sh
50+
pip install virtualenv
51+
```
4852

49-
###7. Install the requirements:
53+
### 7. Install the requirements:
5054

5155
Linux/macOS
5256

53-
`$ virtualenv -p python3 .venv`
54-
`$ . .venv/bin/activate`
55-
`(.venv) $ pip install -r requirements.txt`
57+
```sh
58+
virtualenv -p python3 .venv
59+
. .venv/bin/activate
60+
pip install -r requirements.txt
61+
```
5662

5763
Windows
5864

59-
`C:\programmingbitcoin> virtualenv -p`
60-
`C:\PathToYourPythonInstallation\Python.exe .venv`
61-
`C:\programmingbitcoin> .venv\Scripts\activate.bat`
62-
`C:\programmingbitcoin> pip install -r requirements.txt`
63-
###8. Run Jupyter Notebook:
64-
65-
`(.venv) $ jupyter notebook`
66-
`[I 11:13:23.061 NotebookApp] Serving notebooks from local directory:
67-
/home/jimmy/programmingbitcoin`
68-
`[I 11:13:23.061 NotebookApp] The Jupyter Notebook is running at:
69-
[I 11:13:23.061 NotebookApp] http://localhost:8888/?token=
70-
f849627e4d9d07d2158e3fcde93590eff4a9a7a01f65a8e7`
71-
`[I 11:13:23.061 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).`
72-
`[C 11:13:23.065 NotebookApp]`
73-
`Copy/paste this URL into your browser when you connect for`
74-
`the first time, to login with a token:`
75-
`http://localhost:8888/?token=f849627e4d9d07d2158e3fcde93590eff4a9a7a01f65a8e7`
65+
```cmd
66+
virtualenv -p
67+
PathToYourPythonInstallation\Python.exe .venv
68+
.venv\Scripts\activate.bat
69+
pip install -r requirements.txt
70+
```
7671

72+
### 8. Run Jupyter Notebook:
73+
74+
```cmd
75+
jupyter notebook
76+
```
7777

7878
You should have a browser open up automatically, as shown in [Figure P-1](https://raw.githubusercontent.com/jimmysong/programmingbitcoin/master/images/prbc_0001.png).
7979

8080
![](https://raw.githubusercontent.com/jimmysong/programmingbitcoin/master/images/prbc_0001.png)
8181

82-
MORE INFO AT: [https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/preface01.html#setting_up](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/preface01.html#setting_up)
82+
MORE INFO AT: [https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/preface01.html#setting_up](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/preface01.html#setting_up)

0 commit comments

Comments
 (0)