github-personal/firezone
1
0
Fork 0
mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(docs): Remove outdated rust/connlib/README.md info (#3099)

Browse Source 
This was an artifact leftover from when connlib was in its own repo.
This commit is contained in:
Jamil
2024-01-03 10:10:52 -08:00
committed by GitHub
parent 52edb12bbe
commit aefafc1e49
1 changed files with 3 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
rust/connlib/README.md
View File

@@ -2,32 +2,8 @@
Firezone's connectivity library shared by all clients.
## 🚧 Disclaimer 🚧
**NOTE**: This repository is undergoing heavy construction. You could say we're
_Building In The Open™_ in true open source spirit. Do not attempt to use
anything released here until this notice is removed. You have been warned.
## Building Connlib
Setting the `CONNLIB_MOCK` environment variable when packaging for Apple or Android will activate the `mock` feature flag, replacing connlib's normal connection logic with a mock for testing purposes.
1. You'll need a Rust toolchain installed if you don't have one already. We
recommend following the instructions at https://rustup.rs.
1. `rustup show` will install all needed targets since they are added to `rust-toolchain.toml`.
1. Follow the relevant instructions for your platform:
1. [Apple](#apple)
1. [Android](#android)
1. [Linux](#linux)
1. [Windows](#windows)
### Apple
Connlib should build successfully with recent macOS and Xcode versions assuming
you have Rust installed. If not, open a PR with the notes you found.
### Android
### Linux
### Windows
You shouldn't need to build connlib directly; it's typically built as a
dependency of one of the other Firezone components. See READMEs in those
directories for relevant instructions.