From 73746fccb80340761ce45c090f938ca3b9269f55 Mon Sep 17 00:00:00 2001 From: sadhana19zzz-beep Date: Wed, 7 Oct 2026 14:30:28 +0530 Subject: [PATCH] docs: add development setup instructions --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index e450201..3669f9c 100644 --- a/README.md +++ b/README.md @@ -155,3 +155,20 @@ and monochrome portraits are from [Tiny Dungeon](https://kenney.nl/assets/tiny-d by Kenney (CC0). Built with [Bubble Tea](https://github.com/charmbracelet/bubbletea), [lipgloss](https://github.com/charmbracelet/lipgloss) and [wish](https://github.com/charmbracelet/wish). + +## Development setup + +To work on RFoG locally: + +1. Install Go 1.25 or newer. +2. Clone the repository: + git clone https://github.com/rfog-org/rfog.git + cd rfog +3. Run the test suite: + go test ./... +4. Build the project: + go build -o rfog ./cmd/rfog +5. Start the local server: + ./rfog serve + +For changes to the web client or game engine, see the contributing guide for the project layout and development workflow. \ No newline at end of file