DOCSEARCHbyAlgolia
Submit Docs

Windots Documentation

repository·main·Indexed 19 days ago

https://github.com/scottmckendry/windots

Automated dotfiles for Windows users to configure tools such as PowerShell Core, Neovim, and Windows Terminal. It utilizes Winget and Chocolatey for dependency management, provides visual update indicators in the PowerShell prompt, and includes the CYBERDREAM colour scheme.

Tokens
486
Snippets
1
Records
2
Agent score
17%

What's inside Windots

  1. Overview of Windots features

    main

    Windots is a collection of Windows-friendly dotfiles designed to centralize and automate your Windows development environment configuration.

    Key capabilities include:

    • Automated Dependency Management: Uses Winget and Chocolatey to install required software.
    • Automated Update Checks: Uses Git to check for updates. If updates are available, a 📦 icon is displayed in your PowerShell prompt to notify you.
    • Centralized Configuration: Consolidates various Windows configuration files into a single organized location.
    • CYBERDREAM Colour Scheme: Includes a high-contrast, vibrant colour scheme powered by the CYBERDREAM Neovim colourscheme.

  2. Install Windots

    main

    Windots provides automated installation of dependencies and configuration for Windows Terminal, Neovim, PowerShell Core, and more.

    WARNING

    Windots is under active development. The installation process will overwrite existing configuration files. Back up any files you wish to keep before proceeding.

    Prerequisites

    • PowerShell 7
    • Git
    • Sudo for Windows (Optional): Recommended with the Inline option enabled to allow the script to perform automatic Windots and software updates without manual intervention.

    Installation Steps

    1. Clone the Windots repository to your preferred local directory.
    2. Open an elevated (Administrator) PowerShell prompt.
    3. Execute the Setup.ps1 script.
    # Run from an elevated PowerShell prompt after cloning
./Setup.ps1