https://github.com/scottmckendry/windots
My personal "Windows-friendly" dotfiles.
https://github.com/scottmckendry/windots
dotfiles lua neovim powershell windows windows-terminal
Last synced: 2 days ago
JSON representation
My personal "Windows-friendly" dotfiles.
- Host: GitHub
- URL: https://github.com/scottmckendry/windots
- Owner: scottmckendry
- License: mit
- Created: 2023-06-22T05:13:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-02-11T18:54:05.000Z (10 days ago)
- Last Synced: 2025-02-12T06:11:12.123Z (9 days ago)
- Topics: dotfiles, lua, neovim, powershell, windows, windows-terminal
- Language: Lua
- Homepage: https://scottmckendry.tech/windots
- Size: 995 KB
- Stars: 333
- Watchers: 7
- Forks: 30
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
My personal Windows-friendly dotfiles. Supports automatic installation of dependencies and configuration of Windows Terminal, Neovim, PowerShell Core and more!
## 🎉 Features
- **Automated Dependency Installation:** Utilises [Winget](https://learn.microsoft.com/en-us/windows/package-manager/winget/) and [Chocolatey](https://chocolatey.org/) for streamlined installation of required dependencies. Checks and notifies pending software updates with a 📦 icon in the prompt.
- **Automated Update Checks:** Regularly checks for updates using git. If updates are pending, an icon is displayed when starting a new PowerShell session.
- **Centralized Configuration:** Brings together scattered Windows configuration files into one organized location for easy access and management.
- **Tailored Colour Scheme:** Powered by my very own [CYBERDREAM](https://github.com/scottmckendry/cyberdream.nvim) colourscheme - high-contrast and vibrant for optimal _Eye Stimulation™_.
## âś… Pre-requisites
- [PowerShell 7](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows?view=powershell-7.3#install-powershell-using-winget-recommended)
- [Git](https://winget.run/pkg/Git/Git)
- [Sudo](https://learn.microsoft.com/en-us/windows/sudo/) (Optional) - With the **Inline** option to support automatic Windots & software updates.
## 🚀 Installation
> [!WARNING]\
> Under _**active development**_, expect changes. Existing configuration files will be overwritten. Please make a backup of any files you wish to keep before proceeding.
1. Clone the repository to your preferred location.
2. Run `Setup.ps1` from an elevated PowerShell prompt.
## 🤝 Contributing
Pull requests and issues are welcome. If you have any questions or suggestions, please open an issue or reach out to me on [Twitter](https://twitter.com/scott_mckendry).
## 📸 Screenshots
---
