docs(bud): replace references to flk
This commit is contained in:
parent
f13c11ea17
commit
955b9ce1c1
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
2
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -35,4 +35,4 @@ Please search on the [issue tracker](../) before creating one.
|
||||||
|
|
||||||
## Your Environment
|
## Your Environment
|
||||||
<!--- Include relevant details about the environment you experienced the bug in. -->
|
<!--- Include relevant details about the environment you experienced the bug in. -->
|
||||||
<!--- If you have run `flk update`, for example, post the flake.lock file. -->
|
<!--- If you have run `bud update`, for example, post the flake.lock file. -->
|
||||||
|
|
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -2,7 +2,7 @@ result
|
||||||
.direnv
|
.direnv
|
||||||
doc/index.html
|
doc/index.html
|
||||||
|
|
||||||
# Result of flk commands
|
# Result of bud commands
|
||||||
vm
|
vm
|
||||||
iso
|
iso
|
||||||
doi
|
doi
|
||||||
|
|
|
@ -48,7 +48,7 @@ argument that gets passed to your home-manager users.
|
||||||
|
|
||||||
## External Usage
|
## External Usage
|
||||||
You can easily use the defined home-manager configurations outside of NixOS
|
You can easily use the defined home-manager configurations outside of NixOS
|
||||||
using the `homeConfigurations` flake output. The [flk](../flk/index.md) helper
|
using the `homeConfigurations` flake output. The [bud](../bud/index.md) helper
|
||||||
script makes this even easier.
|
script makes this even easier.
|
||||||
|
|
||||||
This is great for keeping your environment consistent across Unix systems,
|
This is great for keeping your environment consistent across Unix systems,
|
||||||
|
@ -57,10 +57,10 @@ including OSX.
|
||||||
### From within the projects devshell:
|
### From within the projects devshell:
|
||||||
```sh
|
```sh
|
||||||
# builds the nixos user defined in the NixOS host
|
# builds the nixos user defined in the NixOS host
|
||||||
flk home NixOS nixos
|
bud home NixOS nixos
|
||||||
|
|
||||||
# build and activate
|
# build and activate
|
||||||
flk home NixOS nixos switch
|
bud home NixOS nixos switch
|
||||||
```
|
```
|
||||||
|
|
||||||
### Manually from outside the project:
|
### Manually from outside the project:
|
||||||
|
|
|
@ -40,7 +40,7 @@ And the private key to your user:
|
||||||
|
|
||||||
And run the deployment:
|
And run the deployment:
|
||||||
```sh
|
```sh
|
||||||
deploy "flk#hostName" --hostname host.example.com
|
deploy "bud#hostName" --hostname host.example.com
|
||||||
```
|
```
|
||||||
|
|
||||||
> ##### _Note:_
|
> ##### _Note:_
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
Assuming you're happy with your existing partition layout, you can generate a
|
Assuming you're happy with your existing partition layout, you can generate a
|
||||||
basic NixOS configuration for your system using:
|
basic NixOS configuration for your system using:
|
||||||
```sh
|
```sh
|
||||||
flk up
|
bud up
|
||||||
```
|
```
|
||||||
|
|
||||||
This will make a new file `hosts/up-$(hostname).nix`, which you can edit to
|
This will make a new file `hosts/up-$(hostname).nix`, which you can edit to
|
||||||
|
@ -38,7 +38,7 @@ Now might be a good time to read the docs on [suites](../concepts/suites.md) and
|
||||||
|
|
||||||
Once you're ready to deploy `hosts/my-host.nix`:
|
Once you're ready to deploy `hosts/my-host.nix`:
|
||||||
```sh
|
```sh
|
||||||
flk my-host switch
|
bud my-host switch
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -6,10 +6,10 @@ Here is a snippet that will get you the template without the git history:
|
||||||
```sh
|
```sh
|
||||||
nix-shell -p cachix --run "cachix use nrdxp"
|
nix-shell -p cachix --run "cachix use nrdxp"
|
||||||
|
|
||||||
nix-shell https://github.com/divnix/devos/archive/core.tar.gz -A shell \
|
nix-shell https://github.com/divnix/devos/archive/master.tar.gz -A shell \
|
||||||
--run "flk get core"
|
--run "bud get master"
|
||||||
|
|
||||||
cd flk
|
cd bud
|
||||||
|
|
||||||
nix-shell
|
nix-shell
|
||||||
|
|
||||||
|
@ -18,7 +18,7 @@ git add .
|
||||||
git commit -m init
|
git commit -m init
|
||||||
```
|
```
|
||||||
|
|
||||||
This will place you in a new folder named `flk` with git initialized, and a
|
This will place you in a new folder named `bud` with git initialized, and a
|
||||||
nix-shell that provides all the dependencies, including the unstable nix
|
nix-shell that provides all the dependencies, including the unstable nix
|
||||||
version required.
|
version required.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue