docs: add ags readme
All checks were successful
Discord / discord commits (push) Has been skipped

This commit is contained in:
matt1432 2024-01-18 09:41:57 -05:00
parent 7e10374dec
commit d56c451874
3 changed files with 50 additions and 1 deletions

View file

@ -1,5 +1,11 @@
# My NixOS configs # My NixOS configs
## Ags
You might find it weird that most of my config is written in TypeScript.
That is because all my desktops run [AGS](https://github.com/Aylur/ags) for UI.
Click on [this](https://git.nelim.org/matt1432/nixos-configs/src/branch/master/modules/ags) to see my configuration.
## About ## About
This repo is my complete configuration of machines I own, This repo is my complete configuration of machines I own,

43
modules/ags/README.md Normal file
View file

@ -0,0 +1,43 @@
# [AGS](https://github.com/Aylur/ags)
## Nix
This directory is the Nix entrypoint to my AGS configration.
On system activation, if this module is imported, it will
generate the `config.js` of the host with the host's name
as the parameter in `transpileTypeScript` to support a different
setup per device.
## Non-Nix
To use this setup without Nix:
```js
/* ~/.config/ags/config.js */
import { transpileTypeScript } from './js/utils.js';
export default (await transpileTypeScript('wim')).default;
```
If you want to try my main config, this is what you need to have
as your `config.js` after copying the contents of `./config` to
`~/.config/ags`
## Dependencies
The main dependencies to try it are as follows:
- **bun** to transpile TS to JS
- **sassc** to compile SCSS to CSS
- **[coloryou](https://git.nelim.org/matt1432/nixos-configs/src/branch/master/common/pkgs/coloryou)** for media player colors
- **playerctl** for media player functionality
If you're interested in my 2-1 laptop setup, you'll need:
- **ydotool** for my custom on-screen keyboard
- my [patched](https://git.nelim.org/matt1432/nixos-configs/src/branch/master/common/overlays/squeekboard/remove-panel.patch)
version of **squeekboard** to get a dbus interface for keyboard
control (I'm looking into implementing this by itself)
- **lisgd** to have touch screen gestures # TODO: switch to hyprgrass

View file

@ -35,7 +35,7 @@ in {
'' ''
import { transpileTypeScript } from './js/utils.js'; import { transpileTypeScript } from './js/utils.js';
export default (await transpileTypeScript("${hostName}")).default; export default (await transpileTypeScript('${hostName}')).default;
''; '';
}; };