Skip to content

docs: add development setup instructions #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zblauser merged 1 commit into from
Oct 8, 2026
Merged

docs: add development setup instructions #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.