Add build instructions
This commit is contained in:
parent
56f3a5ed3a
commit
02cf21f092
27
README.md
27
README.md
@ -29,3 +29,30 @@ Press 'Enter' to continue...
|
||||
|
||||
This shows that Benford's law only works when the data is not random, such as natural data gathered in real life. This is because for data which Benford's law does work, it's natural data generated following a [power law](https://en.wikipedia.org/wiki/Power_law), which is quite common in nature.
|
||||
|
||||
### Run this program yourself
|
||||
|
||||
If you wish to run this program yourself, you can download it from the releases page for Windows or Linux. You can also build it yourself, instructions below:
|
||||
|
||||
### Build Prerequisites
|
||||
|
||||
You can have pretty much any mainstream Operating System or CPU architecture out there, but you need some buildtime dependancies on your system to move forward. You may already have these, you'll know if you do.
|
||||
|
||||
1. Install Go (https://golang.org/)[https://golang.org/], if you don't know what this is, yes that is a picture of a gopher on the home page but this is no joke.
|
||||
2. Install Git (https://git-scm.com/downloads)[https://git-scm.com/downloads], this is version control software which is used to download this code to be available on your system sp you can run it yourself if you like.
|
||||
|
||||
### Build Instructions
|
||||
|
||||
From a command prompt / shell or whatever you got, clone this repository using git.
|
||||
|
||||
```shell
|
||||
git clone https://deadbeef.codes/steven/benfords-law.git
|
||||
```
|
||||
|
||||
Change directory into the downloaded local copy, then build the program using Go.
|
||||
|
||||
```shell
|
||||
cd benfords-law
|
||||
go build .
|
||||
```
|
||||
|
||||
You will be left with an executable file named benfords-law in the same directory.
|
||||
|
Loading…
Reference in New Issue
Block a user