From b35d35f3d514372bf16a09f6397b74b25b16992c Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Thu, 27 Jun 2024 08:42:42 +0000 Subject: [PATCH] update --- README.md | 6 ++++-- docs/TODO.md | 1 - docs/scripts/create_readme.sh | 4 ++++ docs/src/header.md | 2 +- 4 files changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ae0a03e..9506288 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ [//]: # (Title: Nixy) [//]: # (Description: Nixy is a Hyprland 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/26/24) +[//]: # (Date: 06/27/24) [//]: # (Version: v2.0.1)
@@ -85,6 +85,8 @@ sudo nixos-rebuild switch --flake ~/.config/nixos#yourhostname - [THEMES.md](docs/THEMES.md): How themes work and how to create your own - [APPS.md](docs/APPS.md): Which apps are installed - [SCRIPTS.md](docs/SCRIPTS.md): Scripts that are available +- [KEYBINDINGS.md](docs/KEYBINDINGS.md): Keybindings available in Hyprland + - [TODO.md](docs/TODO.md): What's next (feel free to contribute) - [CONTRIBUTING.md](docs/CONTRIBUTING.md): How to contribute -- [LICENSE](LICENSE): MIT Licensey +- [LICENSE](LICENSE): MIT License diff --git a/docs/TODO.md b/docs/TODO.md index 4228aa4..4131f13 100644 --- a/docs/TODO.md +++ b/docs/TODO.md @@ -8,7 +8,6 @@ feel free to contribute <3 ([CONTRIBUTING.md](CONTRIBUTING.md)) - [ ] Themes - [ ] Upload new wallpapers - [ ] macOS theme - - [ ] Write a hyprland shortcuts markdown file (Parse the hyprland settings conf) - [ ] Tofi (Wofi, but terminal based) - [ ] add golang bin dir to path diff --git a/docs/scripts/create_readme.sh b/docs/scripts/create_readme.sh index 8bb49bd..6393cc3 100644 --- a/docs/scripts/create_readme.sh +++ b/docs/scripts/create_readme.sh @@ -10,11 +10,15 @@ header=$(cat "./docs/src/header.md") table_of_content=$(md-table-of-contents ./docs/src/README_template.md) # https://github.com/anotherhadi/md-table-of-contents version=$(git describe --tags --abbrev=0) readme_content=$(cat "./docs/src/README_template.md") +description=$(curl -s https://api.github.com/repos/anotherhadi/nixy | jq .description) +description="${description%\"}" +description="${description#\"}" header=${header//\{date\}/$(date '+%D')} header=${header//\{primarycolor\}/89b4fa} header=${header//\{backgroundcolor\}/181825} header=${header//\{version\}/$version} +header=${header//\{description\}/$description} readme_content=${readme_content//\{md_table_of_content\}/$table_of_content} echo "$header" >"$README_FILE" diff --git a/docs/src/header.md b/docs/src/header.md index e825e55..0637264 100644 --- a/docs/src/header.md +++ b/docs/src/header.md @@ -1,5 +1,5 @@ [//]: # (Title: Nixy) -[//]: # (Description: Nixy is a Hyprland 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.) +[//]: # (Description: {description}) [//]: # (Author: Hadi) [//]: # (Date: {date}) [//]: # (Version: {version})