From 12b8dbdbdf82be0dd56741fbea25708b6d736599 Mon Sep 17 00:00:00 2001
From: cswimr <seaswimmerthefsh@gmail.com>
Date: Fri, 28 Mar 2025 10:37:49 -0500
Subject: [PATCH] chore(repo): update readme

---
 README.md | 51 ++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 40 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index ea29384..90818be 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,56 @@
 # SeaCogs
 
 [![Discord](https://img.shields.io/discord/1070058354925383681?logo=discord&color=%235661f6)](https://discord.gg/eMUMe77Yb8)
-[![Documentation](https://img.shields.io/badge/docs-CoastalCommits%20Pages-3e83fd?logo=materialformkdocs)](https://seacogs.coastalcommits.com)
+[![Documentation](https://img.shields.io/badge/docs-CoastalCommits%20Pages-3e83fd?logo=materialformkdocs)](https://seacogs.csw.im)
 ![Python Versions](https://img.shields.io/badge/python-3.10%20%7C%203.11-%233776ab?logo=python)
 
 My assorted cogs for Red-DiscordBot.
 
-## Development
+## Developing
 
-To get started with a development environment, first clone this repository.
+You'll need some prerequisites before you can start working on my cogs.  
+[git](https://git-scm.com) - [uv](https://docs.astral.sh/uv)  
+Additionally, I recommend a code editor of some variety. [Visual Studio Code](https://code.visualstudio.com) is a good, beginner-friendly option.
 
-```sh
-git clone https://coastalcommits.com/cswimr/SeaCogs.git
+### Installing Prerequisites
+
+_This section of the guide only applies to Windows systems.
+If you're on Linux, refer to the documentation of the projects listed above. I also offer a [Nix Flake](./flake.nix) that contains all of the required prerequisites, if you're a Nix user._
+
+#### [`git`](https://git-scm.com)
+
+You can download git from the [git download page](https://git-scm.com/downloads/win).
+
+Alternatively, you can use `winget`:
+
+```ps1
+winget install --id=Git.Git -e --source=winget
 ```
 
-Then, install Poetry.
+#### [`uv`](https://docs.astral.sh/uv)
 
-```sh
-pip install poetry
+You can install uv with the following Powershell command:
+
+```ps1
+powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"
 ```
 
-Finally, use Poetry to create a virtual environment with all of the dependencies required by my cogs.
+Alternatively, you can use `winget`:
 
-```sh
-poetry install
+```ps1
+winget install --id=astral-sh.uv -e
+```
+
+### Getting the Source Code
+
+Once you have [`git`](https://git-scm.com) installed, you can use the `git clone` command to get a copy of the repository on your system.
+
+```bash
+git clone https://c.csw.im/cswimr/SeaCogs.git
+```
+
+Then, you can use `uv` to install the Python dependencies required for development.
+
+```bash
+uv sync --frozen
 ```