From f5e75e562d9fd3a6047f17e7f0675b5d528de4c7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9sar=20Alvarez=20Vallero?= Date: Sat, 12 Jun 2021 15:57:59 -0300 Subject: [PATCH] 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. --- README.md | 80 +++++++++++++++++++++++++++---------------------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/README.md b/README.md index a637b041..ccdb6458 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -#[Programming Bitcoin](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/) +# [Programming Bitcoin](https://learning.oreilly.com/library/view/programming-bitcoin/9781492031482/) -###BY[ JIMMY SONG](https://github.com/jimmysong) +### BY[ JIMMY SONG](https://github.com/jimmysong) -#####[O'Reilly Media, Inc.March 2019](https://learning.oreilly.com/library/publisher/oreilly-media-inc/) +##### [O'Reilly Media, Inc.March 2019](https://learning.oreilly.com/library/publisher/oreilly-media-inc/) # LICENSE @@ -11,72 +11,72 @@ Repository for the book to be published by O'Reilly. 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. -##Setting Up +## Setting Up 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: -###1. Install Python 3.5 or higher on your machine: +### 1. Install Python 3.5 or higher on your machine: Windows: -[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 -) +[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) macOS: [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) Linux -#####See your distro docs (many Linux distributions, like Ubuntu, come with Python 3.5+ preinstalled) +##### See your distro docs (many Linux distributions, like Ubuntu, come with Python 3.5+ preinstalled) -###2. Install pip by downloading this script: [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py). +### 2. Install pip by downloading this script: [https://bootstrap.pypa.io/get-pip.py](https://bootstrap.pypa.io/get-pip.py). -###3. Run this script using Python 3: +### 3. Run this script using Python 3: -`$ python3 get-pip.py` +```sh +python3 get-pip.py +``` -###4. Install Git. The commands for downloading and installing it are at [https://git-scm.com/downloads](https://git-scm.com/downloads). +### 4. Install Git. The commands for downloading and installing it are at [https://git-scm.com/downloads](https://git-scm.com/downloads). -###5. Download the source code for this book: +### 5. Download the source code for this book: -`$ git clone https://github.com/jimmysong/programmingbitcoin` -`$ cd programmingbitcoin` +```sh +git clone https://github.com/jimmysong/programmingbitcoin +cd programmingbitcoin +``` -###6. Install virtualenv: +### 6. Install virtualenv: -`$ pip install virtualenv` +```sh +pip install virtualenv +``` -###7. Install the requirements: +### 7. Install the requirements: Linux/macOS -`$ virtualenv -p python3 .venv` -`$ . .venv/bin/activate` -`(.venv) $ pip install -r requirements.txt` +```sh +virtualenv -p python3 .venv +. .venv/bin/activate +pip install -r requirements.txt +``` Windows -`C:\programmingbitcoin> virtualenv -p` -`C:\PathToYourPythonInstallation\Python.exe .venv` -`C:\programmingbitcoin> .venv\Scripts\activate.bat` -`C:\programmingbitcoin> pip install -r requirements.txt` -###8. Run Jupyter Notebook: - -`(.venv) $ jupyter notebook` -`[I 11:13:23.061 NotebookApp] Serving notebooks from local directory: - /home/jimmy/programmingbitcoin` - `[I 11:13:23.061 NotebookApp] The Jupyter Notebook is running at: - [I 11:13:23.061 NotebookApp] http://localhost:8888/?token= - f849627e4d9d07d2158e3fcde93590eff4a9a7a01f65a8e7` - `[I 11:13:23.061 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).` - `[C 11:13:23.065 NotebookApp]` - `Copy/paste this URL into your browser when you connect for` - `the first time, to login with a token:` - `http://localhost:8888/?token=f849627e4d9d07d2158e3fcde93590eff4a9a7a01f65a8e7` +```cmd +virtualenv -p +PathToYourPythonInstallation\Python.exe .venv +.venv\Scripts\activate.bat +pip install -r requirements.txt +``` +### 8. Run Jupyter Notebook: + +```cmd +jupyter notebook +``` 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). ![](https://raw.githubusercontent.com/jimmysong/programmingbitcoin/master/images/prbc_0001.png) -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) \ No newline at end of file +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)