Page MenuHomePhabricator
Files F3509510

No OneTemporary
Actions

View Options

diff --git a/docs/nix_dev_env.md b/docs/nix_dev_env.md
index b6c0c65b6..3ec6829ef 100644
--- a/docs/nix_dev_env.md
+++ b/docs/nix_dev_env.md
@@ -1,46 +1,46 @@
# Motivation
We use Nix to package all of the dependencies for our dev environment. It does several things for us:
- Enables new devs on macOS or Linux to set up our dev environment with just one command
- Makes sure that everybody on the team is using the same versions of all the tools
- Allows us to isolate development dependencies from affecting the host system
For how Nix package management works, please refer to the official [how Nix works guide](https://nixos.org/guides/how-nix-works.html).
# Supported workflows
| Workflow | macOS supported |
| ------------------------------- | --------------- |
| `keyserver` (Node.js) | ✅ |
| `web` (Webpack) | ✅ |
| `native` iOS (React Native) | ❌ **†** |
| `native` Android (React Native) | ❌ **†** |
| C++ services | ❌ **\*** |
| Rust services | ✅ |
**†** Workflow requires additional undocumented steps after Nix installation (e.g. installing XCode, XCode profile, Android Studio, or Android NDK).
**\*** Workflow requires RabbitMQ and AWS/Localstack to be available.
# Requirements
To set up a dev environment using Nix, you will need a macOS or Linux machine.
# Prerequisites
## Nix package manager
To install and configure the [Nix package manager](https://nixos.org), please run:
```
./scripts/install_nix.sh
```
-# Development Environment
+# Development environment
Run `nix develop` to create a dev environment.
-## How Nix Introduces Dependencies to a Development Environment
+## How Nix introduces dependencies to a development environment
Nix installs packages in the Nix store at package-specific paths (e.g. `/nix/store-x7kdiasp...-clang/bin/clang`). When you run `nix develop`, Nix sets environment variables such as `PATH` to expose the binary dependencies to your shell. This model can be extended through shell hooks to support other build toolchains such as `pkg-config`, `cmake`, and many other language specific package managers by simply adding the repective toolchain to `nativeBuildInputs`.

File Metadata

Mime Type
text/x-diff
Expires
Mon, Dec 23, 5:43 AM (12 h, 46 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
2690421
Default Alt Text
(2 KB)

Event Timeline