Merge pull request #17 from datsfilipe/docs-update

docs: update

.envrc

@@ -63,7 +63,7 @@ generate_flake() {
     fi
   fi
 
-  nix eval --raw -f flake.template.nix flake > flake.nix
+  nix eval --raw -f templates/flake.template.nix flake > flake.nix
 }
 
 run_lib_tests() {

README.md

@@ -16,37 +16,89 @@
 
 ```
 .
-├── lib
-├── hosts
+├── assets
 ├── home
 │   ├── base
 │   │   ├── core
-│   │   ├── tui
 │   │   ├── gui
-│   │   └── home.nix
+│   │   └── tui
 │   └── linux
 │       ├── base
-│       ├── gui
-│       ├── core.nix
-│       ├── gui.nix
-│       └── tui.nix
+│       └── gui
+├── hosts
+│   └── dtsf-pc
+│       └── home
+├── lib
 ├── modules
+│   ├── colorscheme
+│   │   ├── integrations
+│   │   └── themes
+│   ├── conf
+│   │   └── integrations
+│   ├── devenvs
+│   │   ├── bun
+│   │   ├── crystal
+│   │   ├── electron
+│   │   ├── elixir
+│   │   ├── git-hooks
+│   │   ├── go
+│   │   ├── nodejs
+│   │   ├── python
+│   │   ├── qmk
+│   │   ├── rust
+│   │   ├── shimeji
+│   │   └── work
 │   ├── nixos
 │   │   ├── base
 │   │   └── desktop
-│   └── shared
-│       ├── base
-│       ├── pkgs
-│       ├── theme
-│       ├── config
-│       └── dev-envs
-├── vars
-│   └── default.nix
-├── flake.nix
-├── flake.lock
-├── README.md
-└── LICENSE
+│   ├── nupkgs
+│   │   ├── devtunnel-cli
+│   │   └── zellij-switch
+│   ├── secrets
+│   └── wallpaper
+├── outputs
+│   └── x86_64-linux
+│       └── src
+├── scripts
+└── vars
 ```
+
+### General directories
+
+- `assets`: images and other assets used in the readme.
+- `home`: home manager general configurations.
+- `hosts`hosts definitions.
+- `lib`: utility functions.
+- `modules`: modules definitions.
+    - `colorscheme`: colorscheme configurations for most used applications.
+    - `conf`: configurations for most used applications.
+    - `devenvs`: development environments.
+    - `nixos`: nixos general configurations.
+    - `nupkgs`: "nix user packages" - using that instead of a nur repo.
+    - `secrets`: secrets module, using sops for encryption.
+    - `wallpaper`: wallpaper definition.
+- `outputs`: outputs of the dotfiles.
+- `outputs`: Contains all the outputs of the dotfiles.
+- `scripts`: Contains all the scripts used in the dotfiles.
+- `vars`: Contains all the variables used in the dotfiles.
+
+### General slices
+
+- `base`: base configurations.
+- `gui`: gui configurations.
+- `tui`: tui configurations.
+- `linux`: linux configurations.
+- `desktop`: desktop configurations.
+- `integrations`: module integrations.
+- `conf`: config files needed for a function, derivation, etc.
+
+### Usage
+
+- To add a new host, need to create host definition and output. Refer to existing hosts as an example.
+- `nixos-generate-config` can be used to generate a new host hardware configuration file.
+- This repository submodules use ssh url's, so you need to update it as needed.
+- `flake.nix` should never be edited manually, as it is generated by `just generate-flake` using `templates/flake.template.nix`.
+
 ## Star History
 
 <a href="https://star-history.com/#datsfilipe/dotfiles&Date">