diff --git a/README.md b/README.md index 6f06be6..4bf15ad 100644 --- a/README.md +++ b/README.md @@ -14,11 +14,7 @@ ## How to Start -Build your container: -```bash -make build-image -``` -After, make sure you initialize the repo with the repo pre-commits: +After, build your container: ```bash make repo-init ``` @@ -34,6 +30,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 @@ -56,6 +64,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