Skip to content

Commit b2f2b6e

Browse files
committed
Updated README.md with additional installation and build information
1 parent b37c732 commit b2f2b6e

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,31 @@ Built with love by Roopesh and friends in Go.
66

77
## Getting Started
88

9+
## Installing using Curl
10+
11+
```
12+
curl -s https://raw.githubusercontent.com/opennetworktools/netmap/refs/heads/main/install.sh | bash
13+
```
14+
915
## Install using Go
1016

1117
```
1218
go install github.com/opennetworktools/[email protected]
1319
```
1420

21+
## Build yourself
22+
23+
### Go
24+
25+
1. Clone the repo
26+
2. Run `go build .`
27+
3. Run `go install`
28+
29+
### Makefile
30+
31+
1. Run `make`
32+
2. Check `dist/` directory
33+
1534
## Usage
1635

1736
The graph can be created using the command `netmap create`,

install.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,9 @@ main() {
6969

7070
install_netmap_cli
7171

72-
printf "\nNetmap CLI installed!\n"
72+
printf "\nNetmap CLI installed!\n"
73+
Printf "\nRun \"netmap version\" to verify the installation."
74+
printf "\nRun \"netmap help\" to get started!\n\n"
7375
}
7476

7577
main

0 commit comments

Comments
 (0)