From 42057d26b1bc3bce99669e8f4c953068af007950 Mon Sep 17 00:00:00 2001 From: Stefan Pinnow Date: Tue, 19 Apr 2022 07:18:28 +0200 Subject: [PATCH] doc: fix markdownlint violations --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1fc88fe..5d2743f 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ by [Manning Publications Co.](https://www.manning.com/). In order to prepare the Julia environment before working with the materials presented in the book please perform the following setup steps: + * [download](https://julialang.org/downloads/) and [install](https://julialang.org/downloads/platform/) [Julia](https://julialang.org/); @@ -32,6 +33,7 @@ presented in the book please perform the following setup steps: Additional instructions how to manage your Julia installation are given in Appendix A to the book. In particular I explain there how to perform a correct configuration of your environment when doing: + * integration with Python using the PyCall.jl package; * integration with R using the RCall.jl package; * installation of Plots.jl (which by default uses the GR Framework that requires @@ -54,11 +56,12 @@ you extracted Julia in, for example, the `/opt` folder, the simplest way to make sure that your system can find `julia` executable is to add it to your system `PATH` environment variable. A standard way to do it is to edit your `~/.bashrc` (or `~/.bash_profile`) file and add there the: -``` + +```text export PATH="$PATH:/opt/julia-1.7.2/bin" ``` -line (assuming you have downloaded Julia 1.7.2 and extracted it to `/opt` folder). +line (assuming you have downloaded Julia 1.7.2 and extracted it to `/opt` folder). ## Organization of the code @@ -77,6 +80,7 @@ and appropriate packages are loaded). ## Running the example codes To work with codes from some given chapter: + * it is recommended to use a machine with at least 8GB of RAM when working with the examples in this book; * start a fresh Julia session using the `julia --project` command in a folder @@ -95,13 +99,14 @@ To work with codes from some given chapter: For your convenience I additionally stored data files that we use in this book. They are respectively: + * movies.dat (for chapter 6, shared on GitHub repository - https://github.com/sidooms/MovieTweetings under MIT license) + under MIT license) * puzzles.csv.bz2 (for chapter 8, available puzzles at - https://database.lichess.org/. The data is distributed under + . The data is distributed under Creative Commons CC0 license) * git_web_ml.zip (for chapter 12, available on Stanford Large Network Dataset Collection website - https://snap.stanford.edu/data/github-social.html under GPL-3.0 License) + under GPL-3.0 License) * owensboro.zip (for chapter 13, available at The Stanford Open Policing Project under the Open Data Commons Attribution License)