docs: add a README once again

This commit is contained in:
winston 2023-02-20 06:48:10 +01:00
parent 0f2d850dcf
commit ccaf65bcdb
Signed by: winston
GPG key ID: 3786770EDBC2B481
2 changed files with 55 additions and 0 deletions

34
.github/README.md vendored Normal file
View file

@ -0,0 +1,34 @@
# winston's dotfiles
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/nekowinston/dotfiles/check.yml?label=flake%20check&logo=nixos&logoColor=%23fff&style=flat-square)
Welcome to my cross-platform dots. Focused on improving productivity, and reducing the pain of switching between operating systems. Minimal rice, with a focus on getting the annoying stuff out of the way.
> **Note**
> I've recently switched to **[Nix](https://nixos.org)** & **[Home-Manager](https://github.com/nix-community/home-manager)** for my dotfile management.\
> Since the chezmoi version of my dots was somewhat popular, I have [tagged them](https://github.com/nekowinston/dotfiles/tree/chezmoi) if you want to use them for reference.
### Overview
Here's what you can find:
- **[WezTerm](https://wezfurlong.org/wezterm/)** as my terminal, with tmux-like keybindings
- **[Neovim](https://neovim.io)** as my tui editor & my JetBrains IdeaVim config
- **[Neomutt](http://www.neomutt.org)** as my mail client
- **[Taskwarrior](https://taskwarrior.org)** for task management
- **[Starship](https://starship.rs)** as my prompt
- **Firefox** with privacy-centered settings
- My **PGP** & **[Sops.nix](https://github.com/Mic92/sops-nix)** settings
- Other random bits of config tools I've collected over the years
- The **[Catppuccin](https://github.com/catppuccin)** theme, wherever possible
- macOS:
- **[Yabai](https://github.com/koekeishiya/yabai)** as my wm
- Linux:
- **[i3](https://i3wm.org)** as my wm
### Todos from my previous chezmoi setup:
These are things I used to have with chezmoi, but are currently missing in this config:
- **[bugwarrior](https://github.com/ralphbean/bugwarrior)** for ticket integration
- **[taskwiki](https://github.com/tools-life/taskwiki)** for task management in neovim

21
LICENSE Normal file
View file

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2023 nekowinston
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.