Update installation instructions, add linting instructions

Signed-off-by: Georgios Ntoutsos <[email protected]>
Reviewed-by: Anastassios Nanos  <[email protected]>
Reviewed-by: Charalampos Mainas <[email protected]>
Approved-by: Anastassios Nanos  <[email protected]>
PR: #11

Author: Georgios Ntoutsos

README.md

@@ -54,7 +54,7 @@ To run a simple `urunc` example locally, you need to address a few dependencies:
 If you already have these requirements, you can run a test container using `nerdctl`:
 
 ```bash
-sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/redis-hvt:annotated unikernel
+sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rump:latest unikernel
 ```
 
 ![demo](docs/img/urunc-nerdctl-example.gif)
@@ -67,6 +67,18 @@ The setup process may differ depending on your system and requirements. A full s
 
 To use `urunc` with an existing Kubernetes cluster, you can follow the [instructions in the docs](docs/How-to-urunc-on-k8s.md).
 
+## Linting
+
+To locally lint the source code using Docker, run:
+
+```bash
+git clone https://github.com/nubificus/urunc.git
+cd urunc
+docker run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.53.3 golangci-lint run -v --timeout=5m
+# OR
+sudo nerdctl run --rm -v $(pwd):/app -w /app golangci/golangci-lint:v1.53.3 golangci-lint run -v --timeout=5m
+```
+
 ## License
 
 [Apache License 2.0](LICENSE)

docs/Installation.md

@@ -24,6 +24,14 @@ sudo apt-get update
 sudo apt-get upgrade -y
 ```
 
+### Install required apt packages
+
+The following apt packages are required to complete the installation. Depending on your specific needs, some of them may not be neccessary in your use case.
+
+```bash
+sudo apt-get install git wget bc make build-essential -y
+```
+
 ### Install Go
 
 To install Go 1.20.6:
@@ -35,6 +43,7 @@ sudo tar -C /usr/local -xzf go1.20.6.linux-$(dpkg --print-architecture).tar.gz
 sudo tee -a /etc/profile > /dev/null << 'EOT'
 export PATH=$PATH:/usr/local/go/bin
 EOT
+rm -f go1.20.6.linux-$(dpkg --print-architecture).tar.gz
 ```
 
 
@@ -185,20 +194,27 @@ Now, we are ready to build and run our unikernel images!
 
 ## Run an example unikernel
 
-### Install solo5-hvt 
+### Install solo5-hvt
+
+First, let's install the apt packages required to build solo5:
+
+```bash
+sudo apt-get install libseccomp-dev pkg-config gcc -y
+```
 
-First, let's download and install `solo5-hvt`.
+Next, we can clone, build and install `solo5-hvt`.
 
 ```bash
-curl -L -o solo5-hvt https://s3.nubificus.co.uk/bima/$(uname -m)/solo5
-sudo mv solo5-hvt /usr/local/bin
-sudo chmod +x /usr/local/bin/solo5-hvt
+git clone -b v0.6.9 https://github.com/Solo5/solo5.git
+cd solo5
+./configure.sh  && make -j$(nproc)
+sudo cp tenders/hvt/solo5-hvt /usr/local/bin
 ```
 
 ### Run a redis unikernel
 
 Now, let's run a unikernel image:
 
 ```bash
-sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/redis-hvt:annotated unikernel
+sudo nerdctl run --rm -ti --snapshotter devmapper --runtime io.containerd.urunc.v2 harbor.nbfc.io/nubificus/urunc/redis-hvt-rump:latest unikernel
 ```