Skip to content

Commit d0aca48

Browse files
Sudan Landgewearyzen
authored andcommitted
chore (docs): make getting started steps more helpful
Unify the way firecracker binary is made available in a directory so that it is easier for the users to copy pase the commands with less modifications. Signed-off-by: Sudan Landge <[email protected]>
1 parent b7e36ff commit d0aca48

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

docs/getting-started.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ To instead build firecracker from source, you will need to have `docker` install
115115
ARCH="$(uname -m)"
116116

117117
# Clone the firecracker repository
118-
git clone https://github.com/firecracker-microvm/firecracker
118+
git clone https://github.com/firecracker-microvm/firecracker firecracker_src
119119

120120
# Start docker
121121
sudo systemctl start docker
@@ -127,10 +127,10 @@ sudo systemctl start docker
127127
# This will produce the firecracker and jailer binaries under
128128
# `./firecracker/build/cargo_target/${toolchain}/debug`.
129129
#
130-
sudo ./firecracker/tools/devtool build
130+
sudo ./firecracker_src/tools/devtool build
131131

132132
# Rename the binary to "firecracker"
133-
mv ./firecracker/build/cargo_target/${ARCH}-unknown-linux-musl/debug/firecracker firecracker
133+
sudo cp ./firecracker_src/build/cargo_target/${ARCH}-unknown-linux-musl/debug/firecracker firecracker
134134
```
135135

136136
### Starting Firecracker
@@ -143,11 +143,10 @@ process via HTTP requests:
143143
API_SOCKET="/tmp/firecracker.socket"
144144

145145
# Remove API unix socket
146-
rm -f $API_SOCKET
146+
sudo rm -f $API_SOCKET
147147

148148
# Run firecracker
149-
./firecracker/build/cargo_target/${ARCH}-unknown-linux-musl/debug/firecracker \
150-
--api-sock "${API_SOCKET}"
149+
sudo ./firecracker --api-sock "${API_SOCKET}"
151150
```
152151

153152
In a new terminal (do not close the 1st one):

0 commit comments

Comments
 (0)