docs: update build instructions to use min Golang version of 1.21

fixes #5
patsec · May 17, 2024 · 5787355 · 5787355
1 parent f7e4529
commit 5787355
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -64,7 +64,7 @@ accordingly, as well as collocate logs generated by all other modules.
 ### Requirements
 
 - `Debian-based Linux` (recommend Ubuntu 20.04 LTS or greater)
-- `golang` v1.18 or greater
+- `golang` v1.21 or greater
 - `build-essential`
 - `cmake` v3.11 or greater
 - `libboost-dev`
@@ -83,7 +83,7 @@ sudo apt update && sudo apt install \
 
 #### Install Golang
 ```
-wget -O go.tgz https://golang.org/dl/go1.20.linux-amd64.tar.gz \
+wget -O go.tgz https://golang.org/dl/go1.21.8.linux-amd64.tar.gz \
   && sudo tar -C /usr/local -xzf go.tgz && rm go.tgz \
   && sudo ln -s /usr/local/go/bin/* /usr/local/bin
 ```
@@ -93,8 +93,8 @@ wget -O go.tgz https://golang.org/dl/go1.20.linux-amd64.tar.gz \
 Install the OT-sim C, C++, and Golang modules.
 
 ```
-cmake -S . -B build && sudo cmake --build build --target install && sudo ldconfig
-sudo make -C src/go install
+cmake -S . -B build && sudo cmake --build build -j$(nproc) --target install && sudo ldconfig \
+  && sudo make -C src/go install
 ```
 
 Install the OT-sim Python modules. This step will also install the Python HELICS

diff --git a/src/go/go.mod b/src/go/go.mod
@@ -1,6 +1,6 @@
 module github.com/patsec/ot-sim
 
-go 1.18
+go 1.21
 
 require (
 	actshad.dev/mbserver v0.3.1
@@ -9,22 +9,22 @@ require (
 	github.com/beevik/etree v1.1.0
 	github.com/cenkalti/backoff v2.2.1+incompatible
 	github.com/eclipse/paho.mqtt.golang v1.4.2
+	github.com/goburrow/serial v0.1.0
 	github.com/gofrs/uuid v4.4.0+incompatible
 	github.com/gorilla/mux v1.8.0
 	github.com/gorilla/websocket v1.5.0
 	github.com/pebbe/zmq4 v1.2.7
 	github.com/prometheus/client_golang v1.12.2
 	github.com/reiver/go-telnet v0.0.0-20180421082511-9ff0b2ab096e
 	golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9
-	golang.org/x/exp v0.0.0-20230905200255-921286631fa9
 	gopkg.in/natefinch/lumberjack.v2 v2.2.1
 )
 
 require (
 	github.com/beorn7/perks v1.0.1 // indirect
 	github.com/cespare/xxhash/v2 v2.1.2 // indirect
-	github.com/goburrow/serial v0.1.0 // indirect
 	github.com/golang/protobuf v1.5.2 // indirect
+	github.com/google/go-cmp v0.5.8 // indirect
 	github.com/matttproud/golang_protobuf_extensions v1.0.1 // indirect
 	github.com/prometheus/client_model v0.2.0 // indirect
 	github.com/prometheus/common v0.32.1 // indirect

diff --git a/src/go/go.sum b/src/go/go.sum
@@ -1,7 +1,3 @@
-actshad.dev/mbserver v0.3.0 h1:zLF578MildaGr7uwlB4HmIRmMH2FYMrAPe4XbOeC2P4=
-actshad.dev/mbserver v0.3.0/go.mod h1:1ED8JMLzb/xwcVu/dv2hIHUnsDmwCtizK/+4pYszSgg=
-actshad.dev/mbserver v0.3.1-0.20230525035923-dce6c34645e8 h1:mBfSKXtKagy5F0gVf6XWGj3aMwNea6uczWdqCFuU/VA=
-actshad.dev/mbserver v0.3.1-0.20230525035923-dce6c34645e8/go.mod h1:1ED8JMLzb/xwcVu/dv2hIHUnsDmwCtizK/+4pYszSgg=
 actshad.dev/mbserver v0.3.1 h1:21LaD2xFRTjmMCAexhNc2yCEP21wdQta0WKK767T3PI=
 actshad.dev/mbserver v0.3.1/go.mod h1:1ED8JMLzb/xwcVu/dv2hIHUnsDmwCtizK/+4pYszSgg=
 actshad.dev/modbus v0.2.0/go.mod h1:8IHuLxLYjoX4NomWdAJkEOsAVJnncMAoppE7wRlIYME=
@@ -130,6 +126,7 @@ github.com/google/go-cmp v0.5.1/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/
 github.com/google/go-cmp v0.5.4/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-cmp v0.5.8 h1:e6P7q2lk1O+qJJb4BtCQXlK8vWEO8V1ZeuEdJNOqZyg=
+github.com/google/go-cmp v0.5.8/go.mod h1:17dUlkBOakJ0+DkrSSNjCkIjxS6bF9zb3elmeNGIjoY=
 github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
 github.com/google/martian v2.1.0+incompatible/go.mod h1:9I4somxYTbIHy5NJKHRl3wXiIaQGbYVAs8BPL6v8lEs=
 github.com/google/martian/v3 v3.0.0/go.mod h1:y5Zk1BBys9G+gd6Jrk0W3cC1+ELVxBWuIGO+w/tUAp0=
@@ -247,8 +244,6 @@ golang.org/x/exp v0.0.0-20191227195350-da58074b4299/go.mod h1:2RIsYlXP63K8oxa1u0
 golang.org/x/exp v0.0.0-20200119233911-0405dc783f0a/go.mod h1:2RIsYlXP63K8oxa1u096TMicItID8zy7Y6sNkU49FU4=
 golang.org/x/exp v0.0.0-20200207192155-f17229e696bd/go.mod h1:J/WKrq2StrnmMY6+EHIKF9dgMWnmCNThgcyBT1FY9mM=
 golang.org/x/exp v0.0.0-20200224162631-6cc2880d07d6/go.mod h1:3jZMyOhIsHpP37uCMkUooju7aAi5cS1Q23tOzKc+0MU=
-golang.org/x/exp v0.0.0-20230905200255-921286631fa9 h1:GoHiUyI/Tp2nVkLI2mCxVkOjsbSXD66ic0XW0js0R9g=
-golang.org/x/exp v0.0.0-20230905200255-921286631fa9/go.mod h1:S2oDrQGGwySpoQPVqRShND87VCbxmc6bL1Yd2oYrm6k=
 golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
 golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
 golang.org/x/lint v0.0.0-20181026193005-c67002cb31c3/go.mod h1:UVdnD1Gm6xHRNCYTkRU2/jEulfH38KcIWyp/GAMgvoE=