Rename ref to docs, move attribution from README to its own file
This commit is contained in:
49
README.md
49
README.md
@@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
## prereqs
|
## prereqs
|
||||||
|
|
||||||
- zsh and git installed
|
- programs installed: git, sed, zsh
|
||||||
- git clone this repo
|
- git clone this repo
|
||||||
|
|
||||||
### specific prereqs, linux distros
|
### specific prereqs, linux distros
|
||||||
@@ -13,7 +13,7 @@
|
|||||||
|
|
||||||
- install the package manager, [homebrew](https://brew.sh/)
|
- install the package manager, [homebrew](https://brew.sh/)
|
||||||
- for aerospace window manager, have only 1 workspace/desktop
|
- for aerospace window manager, have only 1 workspace/desktop
|
||||||
- manual settings, refer to [ref/macos-system-settings](ref/macos-system-settings.md)
|
- manual settings, refer to [docs/macos-system-settings](docs/macos-system-settings.md)
|
||||||
|
|
||||||
## script run
|
## script run
|
||||||
|
|
||||||
@@ -22,52 +22,13 @@
|
|||||||
|
|
||||||
## after script run
|
## after script run
|
||||||
|
|
||||||
- complete manual actions specified in [ref/post-run](ref/post-run.md)
|
- complete manual actions specified in [docs/post-run](docs/post-run.md)
|
||||||
|
|
||||||
## todo items
|
## todo items
|
||||||
|
|
||||||
see [ref/todo.md](ref/todo.md)
|
see [docs/todo.md](docs/todo.md)
|
||||||
|
|
||||||
## attribution
|
## attribution
|
||||||
|
|
||||||
### Original pattern/approach and some key config logic
|
see [docs/attribution.md](docs/attribution.md)
|
||||||
|
|
||||||
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).
|
|
||||||
|
|
||||||
|
|||||||
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).
|
||||||
|
|
||||||
Reference in New Issue
Block a user