status-go/nix
Siddarth Kumar fb88f541f2
chore_: upgrade go to 1.21 (#5216)
2024-05-30 14:22:57 +05:30
..
pkgs chore_: setup ci codeclimate coverage reports (#5101) 2024-05-08 09:25:01 +01:00
scripts fix(nix)_: add USER var when sourcing profile 2024-04-11 16:22:01 +03:00
KNOWN_ISSUES.md nix: Updating Nix Shell and Makefile to use nix-shell 2024-04-09 12:49:06 +03:00
README.md nix: Updating Nix Shell and Makefile to use nix-shell 2024-04-09 12:49:06 +03:00
default.nix nix: Updating Nix Shell and Makefile to use nix-shell 2024-04-09 12:49:06 +03:00
nix.conf nix: Updating Nix Shell and Makefile to use nix-shell 2024-04-09 12:49:06 +03:00
overlay.nix chore_: upgrade go to 1.21 (#5216) 2024-05-30 14:22:57 +05:30
pkgs.nix nix: Updating Nix Shell and Makefile to use nix-shell 2024-04-09 12:49:06 +03:00
shell.nix chore_: setup ci codeclimate coverage reports (#5101) 2024-05-08 09:25:01 +01:00
shells.nix nix: Updating Nix Shell and Makefile to use nix-shell 2024-04-09 12:49:06 +03:00

README.md

Description

This folder contains configuration for Nix, a purely functional package manager used by the Status Go for its build process.

Configuration

The main config file is nix/nix.conf and its main purpose is defining the binary caches which allow download of packages to avoid having to compile them yourself locally.

Shell

In order to access an interactive Nix shell a user should run make shell.

The Nix shell is started in this repo via the nix/scripts/shell.sh script, which is a wrapper around the nix-shell command and is intended for use with our main Makefile. This allows for an implicit use of nix-shell as the default shell in the Makefile.

⚠️ WARNING: To have Nix pick up all changes a new nix-shell needs to be spawned.

Resources

You can learn more about Nix by watching these presentations:

And you can read nix/DETAILS.md for more information.

Known Issues

See KNOWN_ISSUES.md.