commit 34d51cfefa6ed8f6e24c03e0e0c4087a21854bb3 Author: Fabien Devaux Date: Fri Jul 28 22:10:20 2023 +0200 Initial Home page diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..1bbfc36 --- /dev/null +++ b/Home.md @@ -0,0 +1,28 @@ +# Welcome to the pyprland wiki! + +## Pyprland is an hyprland companion app enabling Scratchpads, smart monitor placement and other tweaks. +Check the [plugin list] for the full list of features. +It consists in two things: + +- **a tool**: `pypr` +- **some config file**: `~/.config/hypr/pyprland.json` + +The `pypr` tool only have two built-in commands: + +- `reload` reads the configuration file and attempt to apply the changes +- `--help` lists available commands (including plugins commands) + +Other commands are added by adding plugins. + +The config file uses the following syntax: + +```json +{ + "pyprland": { + "plugins": ["plugin_name"] + }, + "plugin_name": { + "plugin_option": 42 + } +} +``` \ No newline at end of file