Skip to content

Commit

Permalink
Say about adding your own configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
YummyBacon5 authored Nov 14, 2024
1 parent 07b7180 commit ebc9b89
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
# Win Config

Quickly configure Windows with the **objectively** best settings

## To add your own configuration

Please create a [pull request](https://github.com/likes-gay/win-config/pulls), and create a JSON file in the [configs directory](https://github.com/likes-gay/win-config/tree/main/configs). The file's name should be your username.

To see examples of what the file should be like, view other JSON files in there.

# The Options

All the options can all be found in the [configs' README.md](https://github.com/likes-gay/win-config/tree/main/configs#settings-documentation).
Expand All @@ -13,14 +20,17 @@ It works by finding their config based off of the computer's username.
## Single command to download and run the script

### Updated Powershell command

```powershell
Invoke-WebRequest -Uri "https://github.com/likes-gay/win-config/releases/latest/download/likes-gay-config.exe" -OutFile "likes-gay-config.exe"; Start-Process -FilePath ".\likes-gay-config.exe" -Wait; Remove-Item -Path "likes-gay-config.exe"
```

### Legacy CMD command

```cmd
curl -L -o likes-gay-config.exe https://github.com/likes-gay/win-config/releases/latest/download/likes-gay-config.exe && likes-gay-config.exe && del likes-gay-config.exe
```

## Using a Rubber Ducky (badusb) to run the script

Upload the [`payload.dd`](https://github.com/likes-gay/win-config/blob/main/payload.dd) to your USB

0 comments on commit ebc9b89

Please sign in to comment.