Skip to content
This repository has been archived by the owner on Jun 9, 2024. It is now read-only.

Commit

Permalink
additional info
Browse files Browse the repository at this point in the history
  • Loading branch information
corduroybera committed Jan 19, 2024
1 parent 0f57689 commit 519f539
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ If you want to help contribute to the framework, check out the [Framework Specs]
Polaris also supports reproducible development environments using [Nix](https://nixos.org/) with [Flakes](https://nixos.wiki/wiki/Flakes).

1. Install [Nix](https://github.com/DeterminateSystems/nix-installer). We recommend the Determinate Systems installer to automatically configure your system with Flakes turned on.

2. Clone, Setup and Test:

```sh
Expand All @@ -114,12 +115,18 @@ Polaris also supports reproducible development environments using [Nix](https://
nix develop
make test-unit
```

3. Start a local development network:

```sh
make start
```

Note: If you would prefer to automatically load this environment everytime you enter the Polaris directory, you can use `direnv`:

- Create a `.envrc` file with the line `use flake`
- Run `direnv allow`

## 🚧 WARNING: UNDER CONSTRUCTION 🚧

This project is work in progress and subject to frequent changes as we are still working on wiring up the final system.
Expand Down

0 comments on commit 519f539

Please sign in to comment.