You've already forked dotfiles
doc: Update to the README
This commit is contained in:
18
README.md
18
README.md
@@ -8,6 +8,10 @@ Included are configs for:
|
||||
- wezterm
|
||||
- zsh
|
||||
|
||||
Planned configs are:
|
||||
- gitconfig
|
||||
- newsboat
|
||||
|
||||
## Deployment
|
||||
|
||||
> [!CAUTION]
|
||||
@@ -21,9 +25,6 @@ Configurations will be deployed to standard locations for a *nix/Mac user direct
|
||||
|
||||
Configurations and their destinations are listed in the deploy script's associative array (dict) named `configs`. Additions or alterations to locations or new configs are to be added there.
|
||||
|
||||
> [!NOTE]
|
||||
> The wezterm's local configuration file is not currently activated in the `configs` dict. It is meant as a local configuration file and is set up to handle some linux specific configuration settings that may not be applicable. Add this alongside the `wezterm.lua` config (uncommenting in the deploy script) and it will be automatically loaded by the main `wezterm.lua` config.
|
||||
|
||||
## Updating
|
||||
|
||||
`git pull` will give the latest changes and via symlinks they will immediately be available to the appropriate applications.
|
||||
@@ -37,13 +38,14 @@ The configs are an attempt at including some IDE functionalities
|
||||
- Auto-complete via nvim-cmp
|
||||
- LSP setup via lspconfig and mason
|
||||
- Debugging via DAP and plugins
|
||||
- Code snippets via luasnips and a base
|
||||
- Code snippets via luasnips and a base set of snippets
|
||||
- Git integration via gitsigns
|
||||
- Syntax highlighting and symbol parsing via treesitter
|
||||
- Quality of life options
|
||||
- Language aware shortcuts for (un)commenting lines or blocks
|
||||
- Zettlekasten style note plugin for taking/searching/linking notes
|
||||
- Markdown preview that opens a live updating html view of an edited markdown file
|
||||
- Markdown in editor rendering
|
||||
- Telescope fuzzy search for files and file contents
|
||||
|
||||
### Tmux
|
||||
@@ -66,8 +68,9 @@ Cross-platform terminal emulator built from the ground up with speed, good font
|
||||
|
||||
Simple setup with automatic config reloading, a colorscheme, font and a couple other bits.
|
||||
|
||||
The `wezterm.local_linux.lua` file is meant as a template for creating a local configuration while also tracking generic linux xcursor configurations
|
||||
required to fix an issue with cursor display. To use it, copy the file to `~/.config/wezterm/local.lua` and wezterm should reload configs automatically.
|
||||
Handles loading a local configuration file from the `~/.config/wezterm/local.lua` location.
|
||||
|
||||
Contains a fix for Linux cursor rendering and theming, loading only on that OS.
|
||||
|
||||
### Zsh
|
||||
|
||||
@@ -87,11 +90,10 @@ The config adds the following settings outside of oh-my-zsh:
|
||||
- Go binaries
|
||||
- Rust binaries
|
||||
- User $HOME based `.local/bin`
|
||||
- NVM (Nodejs) binaries
|
||||
- Keychain initialization for caching SSH keys
|
||||
- Adding a timing function for checking ZSH load timing
|
||||
- NVM (Nodejs) environment variable setup and completion loading
|
||||
- Local specific configuration file loading, with three initial configs:
|
||||
- `.zsh_aliases`: Aliases for local specific commands
|
||||
- `.zsh_exports`: Exported variables for a specific system
|
||||
- `.zsh_functions`: Custom functions
|
||||
- `.zsh_local`: Local ZSH settings for a specific system such as any environment specific bash required to set up a system's shell or direct ZSH settings
|
||||
|
||||
Reference in New Issue
Block a user