docs: clarify project structure exploration in Getting Started
This commit is contained in:
@@ -64,7 +64,7 @@ clan flakes create my-clan
|
|||||||
|
|
||||||
This command creates a `flake.nix` and some other files for your project.
|
This command creates a `flake.nix` and some other files for your project.
|
||||||
|
|
||||||
## Verify the Project Structure
|
## Explore the Project Structure
|
||||||
|
|
||||||
Take a lookg at all project files:
|
Take a lookg at all project files:
|
||||||
|
|
||||||
@@ -73,24 +73,18 @@ cd my-clan
|
|||||||
tree
|
tree
|
||||||
```
|
```
|
||||||
|
|
||||||
Depending on the current template you should see something like this:
|
For example, you might see something like:
|
||||||
|
|
||||||
``` { .console .no-copy }
|
``` { .console .no-copy }
|
||||||
.
|
.
|
||||||
├── flake.nix
|
├── flake.nix
|
||||||
├── machines
|
├── machines/
|
||||||
│ ├── jon
|
├── modules/
|
||||||
│ │ ├── configuration.nix
|
└── README.md
|
||||||
│ │ └── hardware-configuration.nix
|
|
||||||
│ └── sara
|
|
||||||
│ ├── configuration.nix
|
|
||||||
│ └── hardware-configuration.nix
|
|
||||||
└── modules
|
|
||||||
└── shared.nix
|
|
||||||
|
|
||||||
5 directories, 9 files
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Don’t worry if your output looks different—the template evolves over time.
|
||||||
|
|
||||||
??? info "Recommended way of sourcing the `clan` CLI tool"
|
??? info "Recommended way of sourcing the `clan` CLI tool"
|
||||||
|
|
||||||
The default template adds the `clan` CLI tool to the development shell.
|
The default template adds the `clan` CLI tool to the development shell.
|
||||||
@@ -108,15 +102,11 @@ Depending on the current template you should see something like this:
|
|||||||
To automatically add the `clan` CLI tool to your environment without having to
|
To automatically add the `clan` CLI tool to your environment without having to
|
||||||
run `nix develop` every time, we recommend setting up [direnv](https://direnv.net/).
|
run `nix develop` every time, we recommend setting up [direnv](https://direnv.net/).
|
||||||
|
|
||||||
```bash
|
```
|
||||||
clan machines list
|
clan machines list
|
||||||
```
|
```
|
||||||
|
|
||||||
``` { .console .no-copy }
|
If you see no output yet, that’s expected — [add machines](./add-machines.md) to populate it.
|
||||||
jon
|
|
||||||
sara
|
|
||||||
```
|
|
||||||
|
|
||||||
!!! success
|
!!! success
|
||||||
|
|
||||||
You just successfully bootstrapped your first Clan.
|
You just successfully bootstrapped your first Clan.
|
||||||
|
|||||||
Reference in New Issue
Block a user