divnix/digga
1
1
Fork 0
mirror of https://github.com/divnix/digga.git synced 2024-11-26 02:23:57 +03:00
Code Issues Projects Releases Wiki Activity

📝 docs Update quickstart

Browse Source
This commit is contained in:
Lord-Valen 2023-01-06 00:17:36 -05:00 committed by David Arnold
parent 8541f32257
commit 504459e184
1 changed files with 11 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
doc/start/index.md
View File

@ -4,7 +4,8 @@ The only dependency is nix, so make sure you have it [installed][install-nix].
## Get the Template ## Get the Template
If you currently don't have flakes setup, you can utilize the digga shell to pull the template: If you currently don't have flakes setup, you can utilize the digga shell to
pull the template:
```sh ```sh
nix-shell "https://github.com/divnix/digga/archive/main.tar.gz" \ nix-shell "https://github.com/divnix/digga/archive/main.tar.gz" \
@ -22,37 +23,26 @@ Then make sure to create the git repository:
```sh ```sh
git init git init
git add . git add .
git commit -m init git commit
``` ```
To drop into a nix-shell, if you don't have flakes setup, use the digga shell to create a `flake.lock`: Finally, run `nix-shell` to get to an interactive shell with all the
dependencies, including the unstable nix version required. You can run `menu` to
```sh confirm that you are using digga (expected output includes [docs], [general
nix-shell "https://github.com/divnix/digga/archive/main.tar.gz" \ commands], [linter], etc.).
--run "nix flake lock"
```
Or if you do have flakes support, just run:
```sh
nix flake lock
```
Finally, run `nix-shell` to get to an interactive shell with all the dependencies, including the unstable nix
version required. You can run `menu` to confirm that you are using digga (expected output includes [docs], [general commands], [linter], etc.).
In addition, the [binary cache](../integrations/cachix.md) is added for faster deployment. In addition, the [binary cache](../integrations/cachix.md) is added for faster deployment.
> ##### _Notes:_ > # _Notes:_
> >
> - Flakes ignore files that have not been added to git, so be sure to stage new > - Flakes ignore files that have not been added to git, so be sure to stage new
> files before building the system. > files before building the system.
> - You can choose to simply clone the repo with git if you want to follow > - You can choose to simply clone the repo with git if you want to follow
> upstream changes. > upstream changes.
> - If the `nix-shell -p cachix --run "cachix use nrdxp"` line doesn't work > - If the `nix-shell -p cachix --run "cachix use nrdxp"` line doesn't work you
> you can try with sudo: `sudo nix-shell -p cachix --run "cachix use nrdxp"` > can try with sudo: `sudo nix-shell -p cachix --run "cachix use nrdxp"`
## Next Steps: ## Next Steps
- [Make installable ISO](./iso.md) - [Make installable ISO](./iso.md)