Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(README): home-manager links on github pages #100

Merged
merged 1 commit into from
Apr 3, 2024
Merged

docs(README): home-manager links on github pages #100

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,10 @@ platforms](#setup-on-other-platforms).

This will automatically install the `lorri` command.

**Note**: There's [a known issue](https://github.com/target/lorri/issues/374
"nixpkgs `services.lorri` requires reboot for the user lorri.socket to appear")
preventing the lorri daemon from starting automatically upon installation.
**Note**: There's [a known issue](https://github.com/target/lorri/issues/374 "nixpkgs `services.lorri` requires reboot for the user lorri.socket to appear")
preventing the lorri daemon from starting automatically upon installation.
Until it's resolved, you'll have to reload the user daemon by hand by
running `systemctl --user daemon-reload`, or reboot.


2. **Install direnv.** Add `pkgs.direnv` to `environment.systemPackages` in
your NixOS `configuration.nix` or to `home.packages` in your home-manager
Expand Down Expand Up @@ -137,11 +135,10 @@ continue monitoring and evaluating the Nix expressions in your project's
`shell.nix`, and direnv will automatically reload the environment as it
changes.

direnv will continue to load the *cached environment* when the daemon is not
direnv will continue to load the _cached environment_ when the daemon is not
running. However, the daemon must be running for direnv to reload the
environment based on the current `shell.nix` and its dependencies.


## Editor integration

With the right setup, you can use lorri and direnv to customize your
Expand Down Expand Up @@ -178,9 +175,9 @@ For pinning versions of software during development,
Please use the [issue tracker](https://github.com/nix-community/lorri/issues)
for any problems or bugs you encounter.

* We have monthly [Office Hours](https://calendar.google.com/calendar/ical/s9gbabv28b8mbnb1kfegbplf1c%40group.calendar.google.com/public/basic.ics) on [Google Meet](https://meet.google.com/phf-bfdq-ypp)
* We are on IRC/Matrix, `libera/#lorri` ([Webchat][]), though we might not be responsive at all times.
- We have monthly [Office Hours](https://calendar.google.com/calendar/ical/s9gbabv28b8mbnb1kfegbplf1c%40group.calendar.google.com/public/basic.ics) on [Google Meet](https://meet.google.com/phf-bfdq-ypp)
- We are on IRC/Matrix, `libera/#lorri` ([Webchat][]), though we might not be responsive at all times.

[Webchat]: https://matrix.to/#/#lorri:libera.chat

### Why is lorri not on [crates.io][]?
Expand Down Expand Up @@ -243,7 +240,6 @@ By default, the upgrade command will upgrade from the `canon` branch.
Other upgrade options are available, including upgrading from a
local clone. See `lorri self-upgrade --help` for more details.


## Evaluator + watch design

The evaluator should eagerly reevaluate the Nix expressions as soon as
Expand Down Expand Up @@ -290,7 +286,6 @@ lorri creates an indirect garbage collection root for each .drv in
`$XDG_CACHE_HOME/lorri` (`~/.cache/lorri/` by default) each time it
evaluates your project.


### License & Copyright

Copyright 2019–2020 Target, Copyright 2021 The Nix Community
Expand Down Expand Up @@ -331,7 +326,7 @@ _([Nix as observed by LORRI on 2015-07-13](https://www.nasa.gov/newhorizons/lorr
[direnv-setup]: https://direnv.net/index.html#setup
[direnv-usage]: https://direnv.net/man/direnv.1.html#usage
[home-manager-service]: https://nix-community.github.io/home-manager/options.xhtml#opt-services.lorri.enable
[home-manager]: https://rycee.gitlab.io/home-manager/
[home-manager]: https://nix-community.github.io/home-manager/
[lorri-blog-post]: https://www.tweag.io/posts/2019-03-28-introducing-lorri.html
[nixos-service]: https://nixos.org/nixos/options.html#services.lorri.enable
[nixos]: https://nixos.org/
Loading