https://github.com/scottmckendry/Windots

My personal "Windows-friendly" dotfiles.
https://github.com/scottmckendry/Windots

dotfiles lua neovim powershell windows windows-terminal

Last synced: 5 months 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 (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-26T07:55:16.000Z (5 months ago)
• Last Synced: 2024-11-26T08:31:30.651Z (5 months ago)
• Topics: dotfiles, lua, neovim, powershell, windows, windows-terminal
• Language: Lua
• Homepage: https://scottmckendry.tech/windots
• Size: 700 KB
• Stars: 294
• Watchers: 7
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - scottmckendry/Windots - My personal "Windows-friendly" dotfiles. (Lua)

README

        
 
 

  

    

      

      

    

    
Windots


  





  

    

  

  

    

  

  

    

  

  

    

  



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.

  

  ![image](https://github.com/scottmckendry/Windots/assets/39483124/e84d0294-5662-4d7c-b1ae-88a1f26ca9fd)

- **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)

## 🚀 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

![image](https://github.com/user-attachments/assets/1d00e6a3-dd20-4abb-97f5-81df0363ff38)

![image](https://github.com/user-attachments/assets/b51f1064-0e1a-4467-b308-9855ed275ed8)

![image](https://github.com/user-attachments/assets/ce120611-981b-4b2f-a307-097212200d5f)

![image](https://github.com/user-attachments/assets/bbb67965-4d95-4071-be0a-d3a58c4f1a14)

![image](https://github.com/user-attachments/assets/729cdc6c-961e-46b6-b848-cc4b8ecb923d)

---