README.md (1807B)
1 # desktop-icons 2 3 > Show Files from a Directory on the Desktop 4 5 ## Features 6 7 - [X] Show content from a folder as Icons on the Desktop 8 - [X] Use xdg_user_dir to use the default desktop directory 9 - [X] Start default application for the active file 10 - [X] Update the Icons on changes to the directory (added/removed files) 11 - [X] Drag and Drop Files from/to the Desktop 12 - [X] Launching Apps from the Desktop 13 - [X] Multi-Monitor Support 14 - [ ] Thumbnails for Images/Documents 15 - [ ] Sort Rows of List Store based on Name/Type/Date 16 - [ ] Context-Menu for creating files 17 18 ## Supported Desktops 19 20 > Quoted from [gtk-layer-shell](https://github.com/wmww/gtk-layer-shell) 21 22 This application only works on Wayland, and only on Wayland compositors that 23 support the Layer Shell protocol. Layer shell **is supported** on: 24 - wlroots based compositors (such as **Sway**) 25 - Mir-based compositors (some may not enable the protocol by default and require 26 `--add-wayland-extension zwlr_layer_shell_v1`) 27 28 Layer shell **is not supported** on: 29 - Gnome-on-Wayland 30 - Any X11 desktop 31 32 ## Getting Started 33 34 ### Dependencies 35 36 - gtk+-3.0 37 - gtk-layer-shell 38 39 Arch 40 ```sh 41 sudo pacman -S gtk3 gtk-layer-shell 42 ``` 43 44 ### Installation 45 46 ```sh 47 git clone https://github.com/Geronymos/desktop-icons 48 cd desktop-icons 49 make 50 sudo make install 51 ``` 52 53 Uninstall 54 ```sh 55 sudo make uninstall 56 ``` 57 58 ### Usage 59 60 ```sh 61 dicons 62 ``` 63 64 It's recommended to have this automatically start with your Wayland compositor. 65 For Sway append the following to your config file `.config/sway/config `: 66 ``` 67 exec dicons 68 ``` 69 70 ### Development 71 72 Dependencies 73 - bear 74 75 To have warnings and autocompletion with clangd in Vim you can generate the 76 `compile-commands.json` with 77 ```sh 78 make clangd 79 ``` 80 81 ## License 82 83 This project is licensed under the GPL-3 License - see the `LICENSE` file for details 84