Skip to content

Commit 238b631

Browse files
committed
Update README
1 parent 498bd2c commit 238b631

File tree

1 file changed

+52
-1
lines changed

1 file changed

+52
-1
lines changed

README.md

+52-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,54 @@
11
# lc-shell for Nix
22

3-
This repository contains the Nix version of my Vim/ZSH/Tmux configuration called [lc-shell](https://github.com/lightcode/lc-shell).
3+
This repository contains the Nix version of my Vim/ZSH/Tmux configuration called [lc-shell](https://github.com/lightcode/lc-shell). This configuration is a module for [home-manager](https://github.com/nix-community/home-manager).
4+
5+
6+
## Usage
7+
8+
### Include the module
9+
10+
**Using niv** (you need to install and initialize it before):
11+
12+
```shell
13+
niv add lightcode/lc-shell-nix -v v1.0.0
14+
```
15+
16+
Then, you can import the module like this:
17+
18+
```nix
19+
{
20+
imports = let
21+
sources = import ./nix/sources.nix {};
22+
in [
23+
sources.lc-shell-nix.outPath
24+
];
25+
26+
# ...
27+
}
28+
```
29+
30+
**Or by fetching manually the tarball**:
31+
32+
```nix
33+
{
34+
imports = [
35+
(fetchTarball "https://github.com/lightcode/lc-shell-nix/archive/v1.0.0.tar.gz")
36+
];
37+
}
38+
```
39+
40+
### Enable the module
41+
42+
In your home-manager configuration, you need to enable the features you need:
43+
44+
```nix
45+
{
46+
47+
lc-shell = {
48+
vim.enable = true;
49+
tmux.enable = true;
50+
zsh.enable = true;
51+
};
52+
53+
}
54+
```

0 commit comments

Comments
 (0)