Git-Mirrors/veilid
1
0
Fork 0
mirror of https://gitlab.com/veilid/veilid.git synced 2024-09-19 23:55:59 +00:00
Code Issues Packages Projects Releases Wiki Activity
1793dd90e8
veilid/README.md

3.6 KiB
Raw Blame History

Veilid

Introduction

Obtaining the source code

git clone --recurse-submodules git@gitlab.hackers.town:veilid/veilid.git

Dependencies

GNU/Linux

Development of Veilid on GNU/Linux requires a Debian variant such as Debian itself, Ubuntu or Mint. Pull requests to support other distributions would be welcome!

Running the setup script requires:

  • Android SDK and NDK
  • Rust

You may decide to use Android Studio here to maintain your Android dependencies. If so, use the dependency manager within your IDE. If you do so, you may skip to [Run Veilid setup script](#Run Veilid setup script).

  • build-tools;30.0.3
  • ndk;22.0.7026061
  • cmake;3.22.1

Setup Dependencies using the CLI

Otherwise, you may choose to use Android sdkmanager. Follow the installation instructions for sdkmanager here, then use the command line to install the requisite package versions:

sdkmanager --install "build-tools;30.0.3"
sdkmanager --install "ndk;22.0.7026061"
sdkmanager --install "cmake;3.22.1"

Export environment variables and add the Android SDK platform-tools directory to your path.

cat << EOF >> ~/.profile 
export ANDROID_SDK_ROOT=<path to sdk>
export ANDROID_NDK_HOME=$ANDROID_SDK_ROOT/ndk/22.0.7026061
export PATH=\$PATH:$ANDROID_SDK_ROOT/platform-tools
EOF

Run Veilid setup script

Now you may run the Linux setup script to check your development environment and pull the remaining Rust dependencies:

./setup_linux.sh

macOS

Development of Veilid on MacOS is possible on both Intel and ARM hardware.

Development requires:

  • Xcode, preferably latest version
  • Homebrew here
  • Android SDK and NDK
  • Java 8
  • Rust

You may decide to use Android Studio here to maintain your Android dependencies. If so, use the dependency manager within your IDE. If you do so, you may skip to [Run Veilid setup script](#Run Veilid setup script).

  • build-tools;30.0.3
  • ndk;22.0.7026061
  • cmake;3.22.1

Setup Java

brew install openjdk@8

and then symlink it as appropriate for your system:

Intel:

sudo ln -sfn /usr/local/opt/openjdk@8/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-8.jdk

ARM:

sudo ln -sfn /opt/homebrew/openjdk@8/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk-8.jdk

Setup Dependencies using the CLI

Otherwise, you may choose to use Android sdkmanager. Use the command line to install the requisite package versions: brew install android-commandlinetools

sdkmanager --install "build-tools;30.0.3"
sdkmanager --install "ndk;22.0.7026061"
sdkmanager --install "cmake;3.22.1"

Export environment variables and add the Android SDK platform-tools directory to your path.

cat << EOF >> ~/.zshenv
export ANDROID_SDK_ROOT=$HOME/Library/Android/sdk
export ANDROID_NDK_HOME=$HOME/Library/Android/sdk/ndk/22.0.7026061
export PATH=\$PATH:$HOME/Library/Android/sdk/platform-tools
EOF

Run Veilid setup script

Now you may run the MacOS setup script to check your development environment and pull the remaining Rust dependencies:

./setup_macos.sh

Windows

TODO

Veilid Server

In order to run the veilid-server locally:

cd ./veilid-server
cargo run

In order to see what options are available:

cargo run -- --help

Veilid CLI

In order to connect to your local veilid-server:

cd ./veilid-cli
cargo run

Similar to veilid-server, you may see CLI options by typing:

cargo run -- --help