Reoganize README.org
This commit is contained in:
parent
359ab04faa
commit
82c134a5ba
|
@ -3,11 +3,25 @@
|
|||
|
||||
# Programs that keep binary data in .config need to be excluded
|
||||
borg
|
||||
dockstation
|
||||
gimp
|
||||
qBittorrent
|
||||
Signal
|
||||
Slack
|
||||
|
||||
# Programs which require machine-specific data or cache in their rc files
|
||||
blender
|
||||
discord
|
||||
dolphinrc
|
||||
gwenviewrc
|
||||
gh
|
||||
katerc
|
||||
spectaclerc
|
||||
systemd
|
||||
trashrc
|
||||
vlcrc
|
||||
zoom.conf
|
||||
zoomus.conf
|
||||
|
||||
# Doom-emacs manages this automatically (can also be placed in ~/.emacs)
|
||||
emacs
|
||||
|
|
89
README.org
89
README.org
|
@ -1,4 +1,7 @@
|
|||
#+title: Desktop Environment for Mellite
|
||||
#+title: Cross-Platform Configuration Files
|
||||
|
||||
This is a list of cross-platform configuration files which can be placed in
|
||||
~.config~ directory and enabled at will.
|
||||
|
||||
* Installation
|
||||
|
||||
|
@ -10,7 +13,50 @@ git remote add origin $SOURCE
|
|||
git pull origin main
|
||||
#+end_src
|
||||
|
||||
* Login Manager
|
||||
** Doom emacs
|
||||
|
||||
Install via (can also be placed in ~.emacs~ directory)
|
||||
#+begin_src bash
|
||||
git clone --depth 1 https://github.com/doomemacs/doomemacs ~/.config/emacs
|
||||
~/.config/emacs/bin/doom sync
|
||||
~/.config/emacs/bin/doom env
|
||||
#+end_src
|
||||
|
||||
** Fish
|
||||
|
||||
Install and set the default shell to ~fish~.
|
||||
|
||||
** Utilities
|
||||
|
||||
- ~alacritty~: terminal emulator
|
||||
|
||||
Note that in order to set this as the default terminal, you may need to put
|
||||
the following in ~~/.config/kdeglobals~:
|
||||
#+begin_src
|
||||
[General]
|
||||
TerminalApplication
|
||||
#+end_src
|
||||
- ~mpd~: Music player daemon
|
||||
#+begin_src sh
|
||||
systemctl enable --user mpd
|
||||
systemctl start --user mpd
|
||||
#+end_src
|
||||
Optionally, install ~mpc~
|
||||
- ~cantata~: Controls mpd (other clients are acceptable too)
|
||||
- ~btop~/~htop~: Process monitor
|
||||
|
||||
*** Screenfetch
|
||||
|
||||
- ~neofetch~: Screenfetch
|
||||
- ~macchina~ (aur): Another screenfetch
|
||||
|
||||
* Hyprland Desktop Environment
|
||||
|
||||
** Login Manager
|
||||
|
||||
The login manager is not managed by this configuration but mentioned here since
|
||||
it interacts with the desktop environment. For ~hyprland~, ~sddm~ is
|
||||
recommended.
|
||||
|
||||
- ~sddm~: Enable ~sddm.service~
|
||||
|
||||
|
@ -19,12 +65,12 @@ git pull origin main
|
|||
theme comes with ~plasma-workspace~ which is very bloated to install, so
|
||||
consider some of the alternative themes.
|
||||
|
||||
* Fonts
|
||||
** Fonts
|
||||
|
||||
- ~otf-font-awesome~: Needed for ~waybar~ to render icons
|
||||
- Noto Sans/Serif: System font
|
||||
|
||||
* Hyprland
|
||||
** Hyprland
|
||||
|
||||
Note: Setup does not work with NVIDIA GPU without some tweaks.
|
||||
|
||||
|
@ -53,41 +99,28 @@ convert $IN \
|
|||
|
||||
The command for changing keyboard layouts is handled by ~fcitx5~.
|
||||
|
||||
* Utilities
|
||||
** Utilities
|
||||
|
||||
- ~alacritty~: terminal emulator
|
||||
|
||||
Note that in order to set this as the default terminal, you may need to put
|
||||
the following in ~~/.config/kdeglobals~:
|
||||
#+begin_src
|
||||
[General]
|
||||
TerminalApplication
|
||||
#+end_src
|
||||
- ~wofi~: finding programs, drop in replacement for ~rofi~
|
||||
- ~grimblast~: Screenshot engine
|
||||
- ~dolphin~: File explorer
|
||||
- ~swaylock-effects~: A simple lockscreen
|
||||
- ~mpd~: Music player daemon
|
||||
#+begin_src sh
|
||||
systemctl enable --user mpd
|
||||
systemctl start --user mpd
|
||||
#+end_src
|
||||
Optionally, install ~mpc~
|
||||
- ~cantata~: Controls mpd (other clients are acceptable too)
|
||||
- ~wl-clipboard~: Provides copying
|
||||
- ~btop~/~htop~: Process monitor
|
||||
- ~blueman~: Bluetooth connector
|
||||
|
||||
** Configuration
|
||||
*** Configuration
|
||||
|
||||
- ~lxappearance~: Used to configure GTK3 themes
|
||||
- ~nwg-look~: Configures cursor
|
||||
|
||||
** Diagnostics
|
||||
|
||||
- ~wev~: Wayland event interceptor useful for determining keybinds
|
||||
- ~neofetch~: Screenfetch
|
||||
- ~macchina~ (aur): Another screenfetch
|
||||
|
||||
* Troubleshooting
|
||||
* Dot Files
|
||||
|
||||
All the configurations which must appear as dot files are not included:
|
||||
- ~.bashrc~
|
||||
- ~.vimrc~: Workaround is to install NeoVim
|
||||
- ~.spacemacs~
|
||||
The following default files are not included for the same reason:
|
||||
- ~.astylerc~
|
||||
- ~.clang-format~
|
||||
- ~.latexmkrc~
|
||||
|
|
Loading…
Reference in New Issue