extern/zaneyos
1
0
Fork 1
mirror of https://gitlab.com/Zaney/zaneyos.git synced 2024-11-25 16:13:09 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Leave Maintenance Mode and Update README information

Browse Source
This commit is contained in:
Tyler Kelley 2024-04-18 23:24:32 -05:00
parent 8a2c3c7019
commit e1355905f6
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,8 +1,5 @@
<div align="center">
# MAINTENANCE MODE!
### ZaneyOS is currently being updated and fixed. This is a volatile time to install or update. If you have problems reach out on Discord.
## ZaneyOS 🟰 Best ❄️ NixOS Configs
ZaneyOS is a simple way of reproducing my configuration on any NixOS system. This includes the wallpaper, scripts, applications, config files, and more.
@ -17,7 +14,7 @@ ZaneyOS is a simple way of reproducing my configuration on any NixOS system. Thi
#### 🍖 Requirements
- You must be running on NixOS.
- Must have installed using GPT & UEFI.
- Change settings through script or manually editing options.nix file.
- Manually editing options.nix file in hosts/<yourhostname> folder.
#### 🎹 Pipewire, Spotify, & Notification Menu Controls
- We are using the latest and greatest audio solution for Linux. If you like listening to music Spotify comes pre-installed out of the box. Not to mention you will have media and volume controls in the notification center available in the top bar.
@ -32,6 +29,10 @@ ZaneyOS is a simple way of reproducing my configuration on any NixOS system. Thi
- Easily specify extra packages for your users in the users/users.nix file.
- Easy to understand file structure where each host just has its generated hardware.nix file and option.nix file in a folder with the hostname as its title.
#### 👼 An Incredible Community Focused On Support
- The entire idea of ZaneyOS is to make NixOS an approachable space that is actually a great community that you want to be in.
- Many people who are patient and happy to spend their free time helping you are running ZaneyOS. Feel free to reach out on the Discord for any help with anything.
<div align="center">
![](./config/home/files/media/demo.mp4)
@ -50,7 +51,7 @@ Please do yourself a favor and [read the wiki](https://zaney.org/zaneyos/).
- Contact me on [Discord](https://discord.gg/2cRdBs8) as well, for a potentially faster response.
#### ⚠️ Important Changes!
- **The stable branch is gone, this means this project changes as my system changes. This will help with managing documentation. From now on before updating the repository please ensure the flake is not in maintenance mode. If an announcement has not been made on top of this page and Discord then its safe to pull and use the repository.**
- **ZaneyOS versioning is making its return!** You will now be able to see there are branches labeled as stable. The main branch is the development branch now.
- The [Wiki](https://zaney.org/zaneyos/) has moved to [my website](https://zaney.org). This will make it so the documentation looks better and is more easily searched. You can click the search icon in the menu, on desktop, to search through any page in the entire website.
- **Impermanence/persistence has been moved to only being sourced inside the hardware.nix file. If you want to use this feature then please read the Wiki page about how to implement it.**
@ -84,22 +85,28 @@ cd zaneyos
- *You should stay in this folder for the rest of the install*
Create the host folder for your machine(s)
```
cp -r hosts/default hosts/<your-desired-hostname>
```
**🪧🪧🪧 Edit options.nix 🪧🪧🪧**
Generate your hardware.nix like so:
```
nixos-generate-config --show-hardware-config > hardware.nix
nixos-generate-config --show-hardware-config > hosts/<your-desired-hostname>/hardware.nix
```
Run this to enable flakes and install the flake replacing hostname with whatever you put in the options.nix file:
Run this to enable flakes and install the flake replacing hostname with whatever you put in the hosts/<your-desired-hostname>/options.nix file:
```
NIX_CONFIG="experimental-features = nix-command flakes"
sudo nixos-rebuild switch --flake .#hostname
```
This Flake's user will have the password be set for them as *password*. If you want to change it run a command replacing password with whatever you want to be your password. You then need to copy the output that it gives you like below into your hashedPassword in the system.nix file.
If the username is new, the new user will have the password be set for them as *password*. If you want to change it run a command replacing password with whatever you want to be your password. You then need to copy the output that it gives you like below into your hashedPassword in the system.nix file.
```
mkpasswd -m sha-512 password