Skip to content

docs: Update README.md #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MarcosZ wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update README.md #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d646384
Update README.md
MarcosZ Jan 23, 2025
273478b
Merge branch 'main' into marcos/readme
MarcosZ Jan 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,7 @@
<!-- [![arXiv](https://img.shields.io/badge/arXiv-2409.04653-b31b1b.svg)](https://arxiv.org/abs/2409.04653) -->

## 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
```
Expand All @@ -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
Expand All @@ -56,6 +64,8 @@ Example:
make config-target-network KINOVA_NIC=<your_nic_name>
```

NOTE: this must be done outside the container to take effect on the host machine.

To start the Docker environment:
```bash
make bash
Expand Down