Skip to content

Commit f74e918

Browse files
authored
Improve README.md: more in-depth explaination of build.sh & add permissions as a step in build process
1 parent 24efa36 commit f74e918

File tree

1 file changed

+21
-1
lines changed

1 file changed

+21
-1
lines changed

README.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,31 @@ NxtChain is a blockchain written in Go. It includes features such as block creat
2727
To build the project, simply run the provided buildscript `build.sh`:
2828

2929
```sh
30-
bash ./build.sh
30+
# Mark build.sh as executable if needed
31+
chmod +x ./build.sh
32+
33+
# Run the script
34+
./build.sh
3135
```
3236

3337
The buildscript will then build the NxtChain for multiple operating systems. You will find your built binaries in the `./build` folder.
3438

39+
If automatic builds without user inputs are required, you can add arguments after `./build.sh` as shown here:
40+
41+
```sh
42+
# Build the miner
43+
./build.sh miner
44+
45+
# Build the node
46+
./build.sh node
47+
48+
# Build the wallets
49+
./build.sh wallet
50+
51+
# Build everything
52+
./build.sh all
53+
```
54+
3555
If you are using Windows to build the NxtChain, use a tool such as [Git Bash](https://git-scm.com/downloads/win) or [WSL](https://learn.microsoft.com/en-us/windows/wsl/install) to run the buildscript. A batch file for Windows is **NOT** provided.
3656

3757
If you don't want to build the NxtChain yourself, you will always find a prepared build of the latest commits on the [releases page](https://github.com/NXT-Crypto/nxtchain/releases/tag/latest).

0 commit comments

Comments
 (0)