rensa/core
1
0
Fork 0
mirror of https://gitlab.com/rensa-nix/core.git synced 2026-02-02 07:15:08 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: write docs, add README

Browse source
This commit is contained in:
technofab 2025-12-20 21:27:10 +01:00
parent abe19f9f13
commit a7e20e203c
Signed by: technofab
SSH key fingerprint: SHA256:bV4h88OqS/AxjbPn66uUdvK9JsgIW4tv3vwJQ8tpMqQ
8 changed files with 442 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

37
docs/direnv.md Normal file
View file

@ -0,0 +1,37 @@
# Direnv Integration
Rensa provides a custom `direnv` integration to make your development experience smoother.
It allows you to automatically load development shells defined in your cells.
!!! note
This integration is based on [nix-direnv](https://github.com/nix-community/nix-direnv)
but has been improved and optimized specifically for Rensa usage.
## Setup
1. **Create `.envrc`**: Add the following to your `.envrc` file:
```bash
source $(fetchurl https://gitlab.com/rensa-nix/direnv/-/raw/v0.3.0/direnvrc "sha256-u7+KEz684NnIZ+Vh5x5qLrt8rKdnUNexewBoeTcEVHQ=")
use ren //backend/devShells/default
```
This will automatically load the devShell `default` defined in `cells/backend/devShells.nix`.
1. **Allow Direnv**: Run `direnv allow` to trust the configuration.
## Updating
To update the `direnvrc` to the latest version (or a specific version), you can use `direnv fetchurl`.
1. **Run fetchurl**:
```bash
direnv fetchurl https://gitlab.com/rensa-nix/direnv/-/raw/v0.3.0/direnvrc
```
*Note: Replace `v0.3.0` with the desired version tag.*
1. **Update `.envrc`**: The command above will output a new hash.
Replace the previous version and hash in your `.envrc` with the new values.