diff options
| author | Linus Färnstrand <linus@mullvad.net> | 2018-03-20 15:34:40 +0100 |
|---|---|---|
| committer | Linus Färnstrand <linus@mullvad.net> | 2018-03-21 14:33:36 +0100 |
| commit | ec2e8c68a2c052b0a34d95d70050b95de674159b (patch) | |
| tree | f1f72ea2972a150ff6f863c61f094be575188d05 | |
| parent | 3bfd954a3b04ec00c195bc785a8f2ade6122fe60 (diff) | |
| download | mullvadvpn-ec2e8c68a2c052b0a34d95d70050b95de674159b.tar.xz mullvadvpn-ec2e8c68a2c052b0a34d95d70050b95de674159b.zip | |
Add a vocabulary section to the README
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -182,6 +182,22 @@ preserving features. The crates having `mullvad` in their name on the other hand Rust crates. - **mullvad-daemon/** - Main Rust crate building the daemon binary. + +## Vocabulary + +Explanations for some common words used in the documentation and code in this repository. + +- **App** - This entire product (everything in this repository) is the "Mullvad VPN App", or App for + short. + - **Daemon** - Refers to the `mullvad-daemon` Rust program. This headless program exposes a + management interface that can be used to control the daemon + - **Frontend** - Term used for any program or component that connects to the daemon management + interface and allows a user to control the daemon. + - **GUI** - The Electron + React program that is a graphical frontend for the Mullvad VPN App. + - **CLI** - The Rust program named `mullvad` that is a terminal based frontend for the Mullvad + VPN app. + + ## Quirks - If you want to modify babel-configurations please note that `BABEL_ENV=development` must be used |