From 76792fd1443a60b9c6aa6d3d48868127d0adfaea Mon Sep 17 00:00:00 2001
From: Quaternions <krakow20@gmail.com>
Date: Mon, 9 Dec 2024 18:35:49 -0800
Subject: [PATCH] README: write instructions for each component

---
 README.md | 28 ++++++++++++++++++++++++++--
 1 file changed, 26 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 8bec273..26c6768 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,15 @@
-# STRAFES.NET API
+# STRAFES.NET Map Submission System
 
-## How to Begin Development
+## Components
+- Submissions API (golang) `pkg/` `cmd/`
+- Website `/web/`
+- Script Validation (rust) `validation/`
+
+## How to Begin Development on Each Component
+
+### Submissions API
+
+Prerequisite: golang installed
 
 1. Run `go generate` to ensure the generated API is up-to-date. This project uses [ogen](https://github.com/ogen-go/ogen).
     ```bash
@@ -13,6 +22,21 @@
 
     By default, the project opens at `localhost:8080`.
 
+### Website
+
+Prerequisite: bun installed
+
+1. `cd web`
+2. `bun install`
+3. `bun run dev`
+
+### Script Validation
+
+Prerequisite: rust installed
+
+1. `cd validation`
+2. `cargo run --release`
+
 #### License
 
 <sup>