punkfairie/marleyos
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update readme

Browse source
This commit is contained in:
punkfairie 2025-06-04 18:45:06 -07:00
parent 98001cabd0
commit 247fa01723
Signed by: punkfairie
GPG key ID: B3C5488E9A1A7CA6
1 changed files with 29 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
readme.md
View file

@ -21,35 +21,45 @@ publicly released, therefore things are likely to break.
## 🥚 Inputs
- [Snowfall Lib](https://snowfall.org/guides/lib/quickstart/)
- [Home Manager](https://nix-community.github.io/home-manager/)
- [easy-hosts](https://github.com/tgirlcloud/easy-hosts/tree/main)
- [nix-darwin](https://github.com/nix-darwin/nix-darwin)
- [Home Manager](https://github.com/nix-community/home-manager)
- [Agenix](https://github.com/ryantm/agenix)
- [Stylix](https://codewith.babesonthe.net/punkfairie/rose-pine-nix)
- [Stylix](https://github.com/nix-community/stylix)
- [MarleyVim](https://codewith.babesonthe.net/punkfairie/marleyvim)
## 🐣 Outputs
- _systems:_ System config
- _systems/x86_64-linux/nyx:_ My main desktop, running NixOS.
- _systems/aarch64-darwin/mairley:_ My Macbook Air 2022ish. Main laptop.
- _homes:_ Home manager config
- _homes/x86_64-linux/marley@nyx:_ Home configuration for nyx.
- _homes/aarch64-darwin/marley@mairley:_ Home configuration for mairley.
- _hosts:_ System config
- _hosts/nyx:_ My main desktop, running NixOS.
- _hosts/mairley:_ My Macbook Air 2022ish. Main laptop.
- _hosts/marleycentre:_ My LAN server.
- _hosts/marleynet:_ My public server.
- _modules:_ Most config is done here. The file structure is pretty
self-explanatory.
- _modules/{home,nixos,darwin}/base:_ Anything in a base folder directly under
a platform folder is always enabled and does not include a `<module>.enable`
option.
- _modules/{home,nixos,darwin}/\<category>/base:_ These are not subject to the
above, they simply denote options that apply to the whole category.
- _modules/base:_ Config that applies to both NixOS & macOS.
- _modules/{nixos,darwin,home}/shell:_ Config related to the graphical
environment. That includes theming, window managers/desktop environments,
display managers, etc.
- _overlays_
- _overlays/firefox-addons:_ A few addons that weren't in
[rycee's NUR repo](https://nur.nix-community.org/repos/rycee/).
- _overlays/ddclient:_ Pull in a specific version newer than what's in nixpkgs
because I need [Porkbun](https://porkbun.com/) support.
- _overlays/maple-mono-NF:_ Use
[my build](https://github.com/punkfairie/maple-font) of Maple Mono NF.
- _packages_
<!-- TODO: Make the package download the ROM? -->
- _packages/CEmu-TI-84-Plus-CE:_ CEmu wrapped to include my config. I believe
it still needs the ROM downloaded separately to function.
- _packages/figlet-xero-fonts:_ Adding in [xero's custom fonts](https://github.com/xero/figlet-fonts/).
it still needs the ROM downloaded separately to function. <!-- TODO: Make the package download the ROM? -->
- _packages/figlet-xero-fonts:_ Adding in
[xero's custom fonts](https://github.com/xero/figlet-fonts/).
- _packages/phpstorm-with-node:_ PHPStorm wrapped to give it access to NodeJS.
## 🫶 Credits
- [jakehamilton/config](https://github.com/jakehamilton/config) - the general
structure of my config was heavily inspired by jakehamilton's.
- [isabelroses/dotfiles](https://github.com/isabelroses/dotfiles) - the general
structure of my config was heavily inspired by Isabel's.
- [the nix logo used in this readme](https://lix.systems/)
<!-- TODO: update ddclient -->
<!-- TODO: update maple mono NF -->