Serenity/.guide
2024-04-09 02:55:12 +10:00
..
README.md updated .guide/README.md 2024-04-09 02:55:12 +10:00

What do?

Hi there, if you are not a member of the Serenity Amalgam, feel free to do as you wish with these configs.


Otherwise if you& are a member of the Serenity Amalgam, then please follow this guide to enroll an account.

To get started, add a user by typing micro home/users/users.nix, copy the template in the 'users.users' block and adjust it to match, then repeat with the 'home-manager' block below that, then finally add a $-username.nix file in home/users by copying the existing template and adding whatever you& wish.

A suite of programs and applications has been provided via a shared home.nix file, as well as a common config across machines and users. If you& would like to see what is included by default, then Serenity's account is considered common/shared by all members of the amalgam.

Please do not add or remove entries outside of these mentioned locations, thankyou& <3

When you& make any changes, be sure to type git add --all and then git commit -m "$MSG" where $MSG is a short description of what you& changed. Then you& can type git push to sync it.

If you& plan to make any changes to the "core" directory or files contained within it, please be sure to type git switch core & git pull before doing so, then merge the changes into the hyprland branch from there, this is to ensure muir git tree stays clean, please help ensure this :)