divnix/digga
1
1
Fork 0
mirror of https://github.com/divnix/digga.git synced 2024-12-23 08:02:21 +03:00
Code Issues Projects Releases Wiki Activity
f8ec6efba4
digga/doc/start/index.md
Chris Montgomery e470038a36
docs: remove inaccurate and misleading bootstrapping guides 
Many many people have complained about the misleading documentation.
Rather than continuing the path of "we need to fix this", we can reduce
the harmful effects of the inaccurate docs by removing them all
together.

Since much of the confusion in the "getting started" docs came from
`bud`-specific instructions, and `bud` is being removed, removing the
inaccurate docs also seems like it can be a kick towards replacing them.

Also:

- The NixOS manual is the canonical guide to installation. We don't need
to repeat its instructions.
- The numerous references to networking configuration don't have a place
within Digga -- I'm assuming these are `bud`-specific things which are
no longer relevant with `bud` gone.
2022-07-09 16:29:32 -04:00

1.7 KiB
Raw Blame History

Quick Start

The only dependency is nix, so make sure you have it installed.

Get the Template

If you currently don't have flakes setup, you can utilize the digga shell to pull the template:

nix-shell "https://github.com/divnix/digga/archive/main.tar.gz" \
  --run "nix flake init -t github:divnix/digga"

If you already have flakes support, you can directly pull the template:

nix flake init -t github:divnix/digga

Then make sure to create the git repository:

git init
git add .
git commit -m init

To drop into a nix-shell, if you don't have flakes setup, use the digga shell to create a flake.lock:

nix-shell "https://github.com/divnix/digga/archive/main.tar.gz" \
  --run "nix flake lock"

Or if you do have flakes support, just run:

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 is added for faster deployment.

Notes:
  • Flakes ignore files that have not been added to git, so be sure to stage new files before building the system.
  • You can choose to simply clone the repo with git if you want to follow upstream changes.
  • If the nix-shell -p cachix --run "cachix use nrdxp" line doesn't work you can try with sudo: sudo nix-shell -p cachix --run "cachix use nrdxp"

Next Steps: