mirror of
https://github.com/nmasur/dotfiles
synced 2024-11-21 21:05:38 +00:00
add readme for each directory
This commit is contained in:
parent
7439d4bf39
commit
1cf3405103
9
apps/README.md
Normal file
9
apps/README.md
Normal file
@ -0,0 +1,9 @@
|
||||
# Apps
|
||||
|
||||
These are all my miscellaneous utilies and scripts to accompany this project.
|
||||
|
||||
They can be run with:
|
||||
|
||||
```
|
||||
nix run github:nmasur/dotfiles#appname
|
||||
```
|
5
colorscheme/README.md
Normal file
5
colorscheme/README.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Colorschemes
|
||||
|
||||
Color information for different themes is found here. The colors are sourced
|
||||
and used with [base16](https://github.com/chriskempson/base16) format
|
||||
consistently across the system.
|
5
disks/README.md
Normal file
5
disks/README.md
Normal file
@ -0,0 +1,5 @@
|
||||
# Disks
|
||||
|
||||
These are my [disko](https://github.com/nix-community/disko) configurations,
|
||||
which allow me to save desired disk formatting layouts as a declarative file so
|
||||
I don't have to remember how to format my disks later on.
|
4
docs/README.md
Normal file
4
docs/README.md
Normal file
@ -0,0 +1,4 @@
|
||||
# Documentation
|
||||
|
||||
Reference documents for some of the more complicated services and maintenance
|
||||
tasks.
|
@ -1,5 +1,7 @@
|
||||
# Hosts
|
||||
|
||||
These are the individual machines managed by this flake.
|
||||
|
||||
| Host | Purpose |
|
||||
| --- | --- |
|
||||
| [aws](./aws/default.nix) | AWS AMI |
|
||||
|
21
misc/README.md
Normal file
21
misc/README.md
Normal file
@ -0,0 +1,21 @@
|
||||
# Miscellaneous
|
||||
|
||||
These files contain important data sourced by the configuration, or simply
|
||||
information to store for safekeeping later.
|
||||
|
||||
---
|
||||
|
||||
Creating hashed password for [password.sha512](./password.sha512):
|
||||
|
||||
```
|
||||
mkpasswd -m sha-512
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
Getting key for [public-keys](./public-keys):
|
||||
|
||||
```
|
||||
ssh-keyscan -t ed25519 <hostname>
|
||||
```
|
||||
|
@ -5,4 +5,5 @@
|
||||
| [common](./common/default.nix) | User programs and OS-agnostic configuration |
|
||||
| [darwin](./darwin/default.nix) | macOS-specific configuration |
|
||||
| [nixos](./nixos/default.nix) | NixOS-specific configuration |
|
||||
| [wsl](./wsl/default.nix) | WSL-specific configuration |
|
||||
|
||||
|
7
overlays/README.md
Normal file
7
overlays/README.md
Normal file
@ -0,0 +1,7 @@
|
||||
# Overlays
|
||||
|
||||
These are pinned commits, patches, or new packages for programs in Nixpkgs used
|
||||
by this flake configuration.
|
||||
|
||||
Some of them introduce new functionality, while others could be patching
|
||||
temporary issues.
|
8
templates/README.md
Normal file
8
templates/README.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Templates
|
||||
|
||||
These are new flakes that can be generated quickly using:
|
||||
|
||||
```
|
||||
nix flake init -t github:nmasur/dotfiles#mytemplate
|
||||
```
|
||||
|
Loading…
Reference in New Issue
Block a user