clean README

This commit is contained in:
do butterflies cry? 2026-02-22 13:01:43 +10:00
parent e4f2f7b6a7
commit 4dc6fb7624

View file

@ -1,38 +1,11 @@
## My NixOS Flake
>[!TIP]
> My flake is written using [my Cerulean project](https://github.com/cry128/cerulean). Hopefully
> it can serve as a decent example of my vision with the Cerulean + Snowflake projects.
### Philosophy
> [!TODO] My philosophy has kinda changed since the beginning
### Repo Structure
Modules are organised into groups (ie "Core"), from here a module is structured as either:
1. a single `.nix` file (ie bluetooth.nix). I do this when I won't implement an alternative
2. a directory (ie `sound`) containing a set of alternative implementations and a `default.nix`
that simply imports one of the implementations. For the `sound` example I currently have it structured
to default to `pipewire.nix`. I haven't made alternatives yet but the idea is that it is HIGHLY likely
I do in future.
### Security Considerations
###### Hashing
For services where password hashing is done infrequently (ie my forgejo instance with signups disabled)
use argon2 (argon2id) with default `argon2$2$65536$8$50` (typically). Otherwise bcrypt is preferred.
### TODO
There are a lot of commented `# TODO: ...` items in this repository.
All (most) of my commented directives can be found via this pattern:
```sh
grep -rnE '^\s*(//|#)\s*[A-Z]*:\s*.+$' --exclude-dir=.git 2>/dev/null
```
### Random Explanation of Fonts
There are four types of fonts (to my knowledge at least):
1. serif (funny squigles / small elegant strokes included)
2. sans-serif (meaning "without serifs")
3. monospace (all glyphs are of a uniform size)
4. emoji (cute lil faces)
Fun fact: on Android, the emojis you are seeing are part of the noto-emoji font :)
For finding a font for programming I highly recommend trying https://www.codingfont.com/
>[!TODO]
> My philosophy has kinda changed since the beginning
### Links
#### Inspiration