Rename ref to docs, move attribution from README to its own file
This commit is contained in:
43
docs/attribution.md
Normal file
43
docs/attribution.md
Normal file
@@ -0,0 +1,43 @@
|
||||
# attribution
|
||||
|
||||
## Original pattern/approach and some key config logic
|
||||
|
||||
The original pattern and approach for this project, the program-installation scripts and
|
||||
logic, the copy-configs-and-scripts scripts and logic, the "tmux sessionizer" (tmux
|
||||
session init logic), my initial neovim and tmux configs, and my general workflow/workspace
|
||||
strategy, were derived from several of ThePrimeagen's projects and videos, including a
|
||||
FrontEnd Masters course which he taught (each are listed below). I was unable to locate
|
||||
any required licenses or copyrights for the code contained within these sources, but I
|
||||
wanted to give attribution nonetheless.
|
||||
|
||||
- [dev/setup/config repo](https://github.com/ThePrimeagen/dev)
|
||||
- [neovim config](https://github.com/ThePrimeagen/init.lua)
|
||||
- [tmux sessionizer](https://github.com/ThePrimeagen/tmux-sessionizer)
|
||||
- [YouTube video - neovim config video](https://www.youtube.com/watch?v=w7i4amO_zaE)
|
||||
- [FrontEnd Masters course - dev productivity v2](https://frontendmasters.com/courses/developer-productivity-v2/)
|
||||
|
||||
Author: ThePrimeagen (Michael Paulson)
|
||||
|
||||
## Idea of using a list of programs in a file for build/install
|
||||
|
||||
The idea of using a file with a list of programs in it to build and/or install was inspired by Luke Smith's [LARBS project](https://github.com/LukeSmithxyz/LARBS/tree/master).
|
||||
|
||||
## Some themes and theme-swtiching/setting logic
|
||||
|
||||
The theme configuration files in this repository under
|
||||
[src_files/imports/themes-omarchy-core](src_files/imports/themes-omarchy-core)
|
||||
are copied from, and much of the "theme-switching" or "theme-setting" logic and scripts
|
||||
are derived from, [Omarchy](https://github.com/basecamp/omarchy), which is licensed under
|
||||
the [MIT License](https://github.com/basecamp/omarchy/blob/master/LICENSE).
|
||||
|
||||
Copyright (c) David Heinemeier Hansson
|
||||
|
||||
## Additional/extra themes (Omarchy extra themes)
|
||||
|
||||
Additional theme configuration files in this repository under
|
||||
[src_files/imports/themes-omarchy-extra](src_files/imports/themes-omarchy-extra)
|
||||
are copied or derived from projects of additional conrtibutors to the Omarchy
|
||||
community/ecosystem. For information about authors/licenses/copyrights for each, refer
|
||||
to any LICENSE and/or ATTRIBUTION.md files in each theme's respective directory under
|
||||
[src_files/imports/themes-omarchy-extra](src_files/imports/themes-omarchy-extra).
|
||||
|
||||
36
docs/macos-system-settings.md
Normal file
36
docs/macos-system-settings.md
Normal file
@@ -0,0 +1,36 @@
|
||||
# macOS system settings
|
||||
|
||||
settings for manual configuration in macOS system settings app
|
||||
|
||||
**NOTE:** some of these could be scripted, but for now i'm okay with this manual list
|
||||
|
||||
- desktop & dock
|
||||
- `click wallpaper to reveal desktop`: set to "only in stage manager"
|
||||
- all `drag windows to corner/edge/place` types of options: disabled
|
||||
- `rearrange spaces based on recent use`: disabled
|
||||
- `when switch to app... switch to space with open windows of app`: disabled
|
||||
- `displays have separate spaces`: disabled
|
||||
- `show files on desktop`: enabled
|
||||
- `group windows by application`: enabled
|
||||
- smallest possible dock size
|
||||
- dock on right side of screen
|
||||
- automatically hide and show the dock: enabled
|
||||
- accessibility
|
||||
- display
|
||||
- reduce motion: enabled
|
||||
- reduce transparency: enabled
|
||||
- keyboard
|
||||
- keyboard shortcuts
|
||||
- screenshots
|
||||
- save picture of selected area -> `cmd+shft+s`
|
||||
- copy (clipboard) picture of selected area -> `ctrl+cmd+shft+s`
|
||||
- modifier keys
|
||||
- caps lock key -> `escape`
|
||||
- command -> `control`
|
||||
- alt/option -> `command`
|
||||
- control -> `alt/option`
|
||||
- spotlight
|
||||
- show spotlight search -> `alt+r`
|
||||
|
||||
and in general, just go through most pages/options and set them as desired
|
||||
|
||||
8
docs/post-run.md
Normal file
8
docs/post-run.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# Manual steps needed after dotfile copy and/or installs
|
||||
|
||||
## macOS
|
||||
|
||||
- aerospace
|
||||
- grant aerospace permission in accessibility settings
|
||||
- likely need system reboot before aerospace works
|
||||
|
||||
14
docs/todo.md
Normal file
14
docs/todo.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# todo items
|
||||
|
||||
- config for: terminal (kitty? havoc?)
|
||||
- config for shell (if keeping zsh, may not need anything beyond what i've already done)
|
||||
- config for mpd, and client(s), (mpd clients to consider: mpc, ncmpcpp, ncmpc, inori)
|
||||
- config for mpv (if any, may not need anything)
|
||||
- hyprland config and install on linux
|
||||
- web browsers config and install
|
||||
- get find, xargs, awk (use nawk) as unified as i can across system types
|
||||
- decide on docker? or alternatives like podman? any license concerns?
|
||||
- pick rss reader; newsboat? others? option with inbox and separate queues?
|
||||
- decide if i even want a filemanager; if yes, pick one and configure
|
||||
- decide what i'm doing for music streaming; spotify official? web? tui option?
|
||||
|
||||
61
docs/workflow-and-workspaces-scheme.md
Normal file
61
docs/workflow-and-workspaces-scheme.md
Normal file
@@ -0,0 +1,61 @@
|
||||
# notes regarding my workflow and intended use of workspaces
|
||||
|
||||
## workspaces layout
|
||||
|
||||
idea from the ThePrimeagen: designated workspace/label/desktop per app/purpose
|
||||
|
||||
### current layout
|
||||
|
||||
| key | app/focus |
|
||||
|-----|-----------|
|
||||
| 1. | notes (nvim, obsidian) |
|
||||
| 2. | music makeing - misc |
|
||||
| 3. | music making - daw |
|
||||
| 4. | drawing (gimp) |
|
||||
| 5. | music/audio listening |
|
||||
| 6. | comms (emails, chats, av/calls) |
|
||||
| 7. | web browser |
|
||||
| 8. | terminal (primary; one-off terminals & tui apps can be anywhere) |
|
||||
| 9. | programming - misc (whatever is not in primary terminal) |
|
||||
| 0. | general - misc (catch-all) |
|
||||
|
||||
### ideas/guidelines:
|
||||
- use this consistently accross all machines
|
||||
- if something not applicable for a given machine, just don't have apps or screens
|
||||
present, but maintain absolute position/numbering of each screen
|
||||
- structure the above so that programs which i'm likely to use with one hand off of the
|
||||
keyboard (i.e. to use a trackpad, mouse, stylus, etc) are on the screens that allow
|
||||
for one hand (i.e. the one still on the keyboard) to navigate those screens
|
||||
- for me, using peripherals with right hand, so put programs likely to be used with
|
||||
peripherals where my left hand can switch to them single-handedly (screens 1 to 5)
|
||||
|
||||
## workflow / use notes
|
||||
|
||||
- related to the layout above, my approach is to run almost every window in fullscreen
|
||||
- note: on macOS, this is not mac's notion of fullscreen, which basically moves
|
||||
windows to new workspaces/desktops when going to fullscreen mode; instead, when i
|
||||
say 'fullscreen', the idea is taking up all of the normal screen (excluding the
|
||||
menu bar at the top of the screen)
|
||||
- key bindings are set for moving window focus up/down (vim style: mod + k/j)
|
||||
- the mental model here is that every fullscreen window is in a stack, so i can move
|
||||
focus up and down the stack (and i try to maintain consistent order in stacks,
|
||||
e.g. in the comms workspace, email is always on the bottom and chat apps are above)
|
||||
- for apps with tabs, pair the above mental model of a stack with a mental model of a
|
||||
circular list being in any position in that stack
|
||||
- so, keybindings are also set for previous/next tab (vim style: mod + h/l)
|
||||
- specifically, mod+h is mapped to ctrl+shift+tab and mod+l is mapped to ctrl+tab,
|
||||
so it should work anywhere ctrl+tab and ctrl+shift+tab work
|
||||
- all this said, it is better to keep things simple when possible and avoid having too
|
||||
many windows and/or tabs open at one time; however, with the designated purpose for
|
||||
each workspace and the mental models above, it rarely takes me long to find what i need
|
||||
|
||||
## example cases
|
||||
|
||||
- if i want a particular browser window, i jump to workspace 9, then move focus
|
||||
up or down until i get to the window i want; if the window is right but i need
|
||||
a different tab, i then just move "right or left" through my tabs
|
||||
- if i want a particular music-playing app/tui, i jumpt to workspace 4 and move
|
||||
focus up or down as needed to find it
|
||||
- variation case: if i want a particular terminal workspace, i jump to workspace
|
||||
8, but then i'm in tmux land and navigate via the methods i've set up for tmux
|
||||
|
||||
Reference in New Issue
Block a user