From d6463843f5d2f7374bcc3c4ca97b2e8ca9d1e33f Mon Sep 17 00:00:00 2001 From: Marcos Zuzuarregui Date: Thu, 23 Jan 2025 15:41:54 -0800 Subject: [PATCH] Update README.md --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5d0487a..e89cc88 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,6 @@ ## How to Start -Make sure you initialize the repo with the repo pre-commits: -```bash -make repo-init -``` - After, build your container: ```bash make build-image @@ -36,6 +31,18 @@ Next, standup the VNC container to forward X11 to your web browser. You can see make vnc ``` +### Development +If you plan on contributing, make sure you bash into the container and then initialize the git precommit checks: +To start the Docker environment: +```bash +make bash +``` + +Once inside, make sure you initialize the repo with the repo pre-commits: +```bash +make repo-init +``` + ### Simulation To start the Docker environment: ```bash @@ -58,6 +65,8 @@ Example: make config-target-network KINOVA_NIC= ``` +NOTE: this must be done outside the container to take effect on the host machine. + To start the Docker environment: ```bash make bash