Skip to content
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

Jump to bottom

[docs] Improve docs for Windows initial setup #1451

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

[docs] Improve docs for Windows initial setup #1451

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions doc/building-windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,3 +79,5 @@ nmake all
# Build Demikernel in debug mode with the default configuration.
nmake DEBUG=yes all
```

Alternatively, you can also run `cargo build` in the root directory. (after which you may run `cargo build --examples` to build examples)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any particular reason to use cargo commands directly to build? It would be good to just limit the interface to build using the nmake command, so that we have the room to change the behavior at a later point. If there's a need to use this command particularly, we should document it here.

8 changes: 4 additions & 4 deletions doc/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,10 +56,10 @@ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
- Copy the template from `scripts/config/default.yaml` to
`$HOME/config.yaml`. If running on Azure, use `scripts/config/azure.yaml`.
- Open the file in `$HOME/config.yaml` for editing and do the following:
- Change `XX.XX.XX.XX` to match the IPv4 address that in the local host.
- Change `ff:ff:ff:ff:ff:ff` to match the MAC address in the local host.
- Change `abcde` to match the name of the interface in the local host.
- Change the `arp_table` according to your setup. Each line should contain the MAC address of a host matched to the IP address of the same host.
- Change `XX.XX.XX.XX` to match the IPv4 address that in the local host. (for example, 127.0.0.1 if you are running local-to-local tests on your dev machine)
- Change `ff:ff:ff:ff:ff:ff` to match the MAC address in the local host. (optional if you are running local-to-local test)
- Change `abcde` to match the name of the interface in the local host. (optional if you are running local-to-local test)
- Change the `arp_table` according to your setup. Each line should contain the MAC address of a host matched to the IP address of the same host. (optional if you are running local-to-local test)
- If using DPDK, change `WW:WW.W` to match the PCIe address of your NIC.
- Save the file.

Expand Down