update
This commit is contained in:
Hadi
parent
087dd4dfec
commit
d8659825a2
165
README.md
165
README.md
@ -1,88 +1,77 @@
|
||||
[//]: # (Title: Nixys)
|
||||
[//]: # (Author: Hadi)
|
||||
[//]: # (Tags: #...)
|
||||
[//]: # (Date: June 17, 2024)
|
||||
|
||||
<h1 align="center">
|
||||
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
|
||||
<br>
|
||||
Nixy
|
||||
<br>
|
||||
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" /> <br>
|
||||
<div align="center">
|
||||
|
||||
<div align="center">
|
||||
<p></p>
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
|
||||
</a>
|
||||
</div>
|
||||
<br>
|
||||
</div>
|
||||
</h1>
|
||||
|
||||
**Nixy** is a NixOS configuration with home-manager, secrets and custom theming all in one place.
|
||||
It's a simple way to manage your system configuration and dotfiles.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Gallery](#gallery)
|
||||
- [Architecture](#architechture)
|
||||
- [Settings, Themes and colors](#settings-themes-and-colors)
|
||||
- [Scripts](#scripts)
|
||||
- [Nix/NixOs shortcuts](#nixnixos-shortcuts)
|
||||
- [Brightness control](#brightness-control)
|
||||
- [Sound control](#sound-control)
|
||||
- [Caffeine](#caffeine)
|
||||
- [Night-Shift](#night-shift)
|
||||
- [Nerdfont FZF](#nerdfont-fzf)
|
||||
- [Compress/Extract](#compressextract)
|
||||
- [Installation/build](#installationbuild)
|
||||
|
||||
## Gallery
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Architecture
|
||||
|
||||
- `home` are the dotfiles and configuration files for the user
|
||||
- `hosts` are the system configuration files
|
||||
- `laptop` is mine
|
||||
- `guest` is a template for you
|
||||
- `themes` contains all the themes available (you can create your own)
|
||||
- `shared` are some nix files that you can import (nvidia, prime, fonts, ...)
|
||||
- `secrets` are the secrets files encrypted with sops
|
||||
|
||||
## Installation/build
|
||||
|
||||
```sh
|
||||
git clone https://github.com/anotherhadi/nixy ~/.config/nixos
|
||||
```
|
||||
|
||||
- Change the username in the flake.nix file
|
||||
- import the guest configuration instead of the `hosts/laptop` one
|
||||
- import your hardware-configuration.nix into the `hosts/guest` folder
|
||||
|
||||
```sh
|
||||
sudo nixos-rebuild switch --flake ~/.config/nixos#nixy
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
Feel free to contribute to this project by opening an issue or a pull request.
|
||||
[//]: # (Title: Nixy)
|
||||
[//]: # (Description: Nixy is a NixOS configuration with home-manager, secrets and custom theming all in one place. It's a simple way to manage your system configuration and dotfiles.)
|
||||
[//]: # (Author: Hadi)
|
||||
[//]: # (Date: 06/17/24)
|
||||
|
||||
<div align="center">
|
||||
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
|
||||
</div>
|
||||
|
||||
<br><br>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<br><br>
|
||||
|
||||
<div align="center">
|
||||
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" />
|
||||
</div>
|
||||
|
||||
# Nixy
|
||||
|
||||
**Nixy** is a NixOS configuration with home-manager, secrets and custom theming all in one place.
|
||||
It's a simple way to manage your system configuration and dotfiles.
|
||||
|
||||
## Table of Content
|
||||
|
||||
- [Nixy](#nixy)
|
||||
- [Table of Content](#table-of-content)
|
||||
- [Gallery](#gallery)
|
||||
- [Architecture](#architecture)
|
||||
- [Installation](#installation)
|
||||
|
||||
## Gallery
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Architecture
|
||||
|
||||
- 🏠 `home` are the dotfiles and configuration files for the user
|
||||
- 💻 `hosts` are the system configuration files
|
||||
- `laptop` is mine
|
||||
- `guest` is a template that you can copy and modify for your own system
|
||||
- `themes` contains all the themes available (see [[docs/THEMES.md]])
|
||||
- `shared` are some nix files that you can import (nvidia, prime, fonts, ...)
|
||||
- 🤫 `secrets` are the secrets files encrypted with sops
|
||||
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
git clone https://github.com/anotherhadi/nixy ~/.config/nixos
|
||||
```
|
||||
|
||||
- Change the username in the flake.nix file
|
||||
- import the guest configuration instead of the `hosts/laptop` one
|
||||
- import your hardware-configuration.nix into the `hosts/guest` folder
|
||||
|
||||
```sh
|
||||
sudo nixos-rebuild switch --flake ~/.config/nixos#nixy
|
||||
```
|
||||
|
||||
@ -30,4 +30,4 @@
|
||||
| Misc | lazygit |
|
||||
| | neofetch |
|
||||
| | cava |
|
||||
| | ... |
|
||||
| | ... |
|
||||
|
||||
@ -4,7 +4,7 @@ Everybody is invited and welcome to contribute to Nixy. There is a lot to do...
|
||||
|
||||
The process is straight-forward.
|
||||
|
||||
- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0 and 1)
|
||||
- Fork Nixy [git repository](https://github.com/anotherhadi/nixy).
|
||||
- Write your changes (new theme, bug fixes, ...).
|
||||
- Create a Pull Request against the main branch of Nixy.
|
||||
- Read [How to get faster PR reviews](https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews) by Kubernetes (but skip step 0 and 1)
|
||||
- Fork Nixy [git repository](https://github.com/anotherhadi/nixy).
|
||||
- Write your changes (new theme, bug fixes, ...).
|
||||
- Create a Pull Request against the main branch of Nixy.
|
||||
|
||||
@ -48,4 +48,4 @@ It will copy the selected icon to the clipboard.
|
||||
Some shortcut to compress and extract files.
|
||||
|
||||
- `compress` ...
|
||||
- `extract` ...
|
||||
- `extract` ...
|
||||
|
||||
@ -8,4 +8,4 @@ You can change the selected theme by changing the import statement at the top of
|
||||
## Create your own theme
|
||||
|
||||
Create a copy of one of the existing theme and change the variables.
|
||||
Wallpapers are loaded from the `home/wallpapers` folder.
|
||||
Wallpapers are loaded from the `home/wallpapers` folder.
|
||||
|
||||
@ -1,6 +1,5 @@
|
||||
# Todolist
|
||||
|
||||
- [ ] Readme generation
|
||||
- [ ] Installation script
|
||||
- [ ] Compress png docs/src
|
||||
- [ ] Find a new icon theme (White, flat)
|
||||
@ -14,6 +13,6 @@
|
||||
- [ ] Make hyprcursor work
|
||||
- [ ] Remove folder's laptop conf
|
||||
- [ ] Nixvim
|
||||
- [ ] Telescope shortcut for file content
|
||||
- [ ] Markdown snippets
|
||||
- [ ] Make whichkey better
|
||||
- [ ] Telescope shortcut for file content
|
||||
- [ ] Markdown snippets
|
||||
- [ ] Make whichkey better
|
||||
|
||||
@ -1,2 +1,9 @@
|
||||
# for file in ./docs/src/*.png
|
||||
# optipng $file
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# Compress png files in ./docs/src
|
||||
|
||||
[[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1)
|
||||
|
||||
for file in ./docs/src/*.png; do
|
||||
optipng "$file"
|
||||
done
|
||||
|
||||
@ -1,6 +1,14 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# check if file exist: ./docs/src/README_template.md
|
||||
# copy ./docs/src/README_template.md
|
||||
# replace {md_table_of_content} by the table of content
|
||||
# place it in ./README.md
|
||||
# Create the README.md file from the docs/src/README_template.md file
|
||||
|
||||
[[ -d "./docs" ]] || (echo "Folder ./docs not found" && exit 1)
|
||||
|
||||
README_FILE="./README.md"
|
||||
|
||||
header=$(cat "./docs/src/header.md")
|
||||
table_of_content=$(~/go/bin/md-table-of-contents ./docs/src/README_template.md)
|
||||
readme_content=$(cat "./docs/src/README_template.md")
|
||||
|
||||
echo "${header//\{date\}/$(date '+%D')}" >"$README_FILE"
|
||||
echo "${readme_content//\{md_table_of_content\}/$table_of_content}" >>"$README_FILE"
|
||||
|
||||
@ -1 +1,41 @@
|
||||
# Script to take the rice screenshots
|
||||
#!/usr/bin/env bash
|
||||
|
||||
theme_name="nixy"
|
||||
|
||||
# Switch to workspace 1
|
||||
sleep 2
|
||||
|
||||
# Step 1
|
||||
kitty --class peaclock peaclock &
|
||||
sleep 1
|
||||
menu &
|
||||
sleep 1
|
||||
hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "1.png" -d
|
||||
sleep 2
|
||||
pkill peaclock
|
||||
menu
|
||||
sleep 2
|
||||
|
||||
# Step 2
|
||||
kitty cmatrix &
|
||||
sleep 1
|
||||
kitty &
|
||||
sleep 1
|
||||
qutebrowser &
|
||||
sleep 3
|
||||
hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "2.png" -d
|
||||
sleep 2
|
||||
pkill cmatrix
|
||||
pkill --newest qutebrowser ""
|
||||
pkill --newest kitty
|
||||
sleep 2
|
||||
|
||||
# Step 3
|
||||
kitty cava &
|
||||
sleep 1
|
||||
spotify &
|
||||
sleep 10
|
||||
brightness-down
|
||||
sleep 1
|
||||
hyprshot -m "output" -m "active" -o "$HOME/.config/nixos/docs/src/$theme_name" -f "3.png" -d
|
||||
sleep 2
|
||||
|
||||
@ -1,58 +1,30 @@
|
||||
<h1 align="center">
|
||||
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
|
||||
<br>
|
||||
Nixy
|
||||
<br>
|
||||
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" /> <br>
|
||||
<div align="center">
|
||||
|
||||
<div align="center">
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
|
||||
</a>
|
||||
</div>
|
||||
<br>
|
||||
</div>
|
||||
</h1>
|
||||
# Nixy
|
||||
|
||||
**Nixy** is a NixOS configuration with home-manager, secrets and custom theming all in one place.
|
||||
It's a simple way to manage your system configuration and dotfiles.
|
||||
|
||||
## Table of Contents
|
||||
## Table of Content
|
||||
|
||||
{md_table_of_content}
|
||||
|
||||
## Gallery
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Architecture
|
||||
|
||||
- `home` are the dotfiles and configuration files for the user
|
||||
- `hosts` are the system configuration files
|
||||
- 🏠 `home` are the dotfiles and configuration files for the user
|
||||
- 💻 `hosts` are the system configuration files
|
||||
- `laptop` is mine
|
||||
- `guest` is a template for you
|
||||
- `themes` contains all the themes available (you can create your own)
|
||||
- `guest` is a template that you can copy and modify for your own system
|
||||
- `themes` contains all the themes available (see [[docs/THEMES.md]])
|
||||
- `shared` are some nix files that you can import (nvidia, prime, fonts, ...)
|
||||
- `secrets` are the secrets files encrypted with sops
|
||||
- 🤫 `secrets` are the secrets files encrypted with sops
|
||||
|
||||
## Installation/build
|
||||
## Installation
|
||||
|
||||
```sh
|
||||
git clone https://github.com/anotherhadi/nixy ~/.config/nixos
|
||||
@ -65,7 +37,3 @@ git clone https://github.com/anotherhadi/nixy ~/.config/nixos
|
||||
```sh
|
||||
sudo nixos-rebuild switch --flake ~/.config/nixos#nixy
|
||||
```
|
||||
|
||||
## Contribute
|
||||
|
||||
Feel free to contribute to this project by opening an issue or a pull request.
|
||||
|
||||
@ -1,30 +1,34 @@
|
||||
<h1 align="center">
|
||||
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
|
||||
<br>
|
||||
Nixy
|
||||
<br>
|
||||
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" /> <br>
|
||||
<div align="center">
|
||||
[//]: # (Title: Nixy)
|
||||
[//]: # (Description: Nixy is a NixOS configuration with home-manager, secrets and custom theming all in one place. It's a simple way to manage your system configuration and dotfiles.)
|
||||
[//]: # (Author: Hadi)
|
||||
[//]: # (Date: {date})
|
||||
|
||||
<div align="center">
|
||||
<p></p>
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
|
||||
</a>
|
||||
</div>
|
||||
<br>
|
||||
</div>
|
||||
</h1>
|
||||
<div align="center">
|
||||
<img src="https://image.nostr.build/70ebe2b5183879d8c0ffa682cd0089e030ad01909678b242ed86449517eac3a5.png" width="100px" />
|
||||
</div>
|
||||
|
||||
<br><br>
|
||||
|
||||
<div align="center">
|
||||
<a href="https://github.com/anotherhadi/nixy">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=Version&message=2.0.0&colorA=040409&colorB=a158ff&logo=githubactions&logoColor=a158ff&"/>
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/stargazers">
|
||||
<img src="https://img.shields.io/github/stars/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=starship&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/">
|
||||
<img src="https://img.shields.io/github/repo-size/anotherhadi/nixy?color=a158ff&labelColor=040409&style=for-the-badge&logo=github&logoColor=a158ff">
|
||||
</a>
|
||||
<a href="https://nixos.org">
|
||||
<img src="https://img.shields.io/badge/NixOS-unstable-blue.svg?style=for-the-badge&labelColor=040409&logo=NixOS&logoColor=a158ff&color=a158ff">
|
||||
</a>
|
||||
<a href="https://github.com/anotherhadi/nixy/blob/main/LICENSE">
|
||||
<img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&colorA=040409&colorB=a158ff&logo=unlicense&logoColor=a158ff&"/>
|
||||
</a>
|
||||
</div>
|
||||
|
||||
<br><br>
|
||||
|
||||
<div align="center">
|
||||
<img src="https://image.nostr.build/aaf8cf0f3b9784c817f8cf328f19222db2e1886dfb89ae97de83ffa101d437b4.png" width="600px" />
|
||||
</div>
|
||||
|
||||
BIN
docs/src/nixy/1.png
Normal file
BIN
docs/src/nixy/1.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.2 MiB |
BIN
docs/src/nixy/2.png
Normal file
BIN
docs/src/nixy/2.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 566 KiB |
BIN
docs/src/nixy/3.png
Normal file
BIN
docs/src/nixy/3.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 811 KiB |
Loading…
Reference in New Issue
Block a user