Document a way to get Veilid from source on Windows

This provides one method for getting the Veilid source code on
Windows, and launching a node. It is mainly intended to confirm that
https://gitlab.com/veilid/cursive-flexi-logger-view/-/merge_requests/1
addresses a build problem.

It provides a "development" environment in the sense that one could,
in theory, edit the .rs files in Notepad. It does not discuss whether
there is any value in seeing the debug messages in a cmd.exe window,
and does not document other deployment options that may be possible,
such as a Windows service. The information could be revised later to
be more maintainable, e.g., by avoiding the hardcoded protoc and capnp
version numbers and removing the x86_64 assumption.
This commit is contained in:
Rivka Segan 2023-09-03 07:44:25 +00:00
parent 087aef966c
commit 082a8cfb7e

View File

@ -142,7 +142,34 @@ cd veilid-flutter
### Windows ### Windows
**TODO** For a simple installation allowing Rust development, follow these steps:
Install Git from https://git-scm.com/download/win
Install Rust from https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe
Ensure that protoc.exe is in a directory in your path. For example, it can be obtained from https://github.com/protocolbuffers/protobuf/releases/download/v24.2/protoc-24.2-win64.zip
Ensure that capnp.exe is in a directory in your path. For example, it can be obtained from https://capnproto.org/capnproto-c++-win32-0.10.4.zip
Start a Command Prompt window.
```shell
git clone https://gitlab.com/veilid/veilid.git
cd veilid
cargo build
cd target
cd debug
veilid-server.exe
```
This may result in a popup window from local security software, asking whether you wish to allow network access by veilid-server.exe.
To use the CLI, navigate to the above `debug` directory in another Command Prompt window (while veilid-server.exe is still running), and type:
```shell
veilid-cli.exe
```
## Running the Application(s) ## Running the Application(s)