[Documentation] README polish for public release

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Blocks

#165 [Documentation] Update mcrogueface.github.io website

john/McRogueFace

Depends on

#164 [Tiny Feature] Add mcrfpy.__version__ for version identity

john/McRogueFace

Reference

john/McRogueFace#168

john commented

2025-12-29 03:54:53 +00:00

Owner

Summary

The README.md has placeholder content that needs to be filled in before public release.

Current Issues

Empty image placeholder: ![ Image ]()
Blank download link: **Download**: with nothing after
Build instructions reference build_deps.tar.gz that may not be published

Tasks

Content

Add real screenshot of McRogueFace in action
Add download links to releases (AppImage, Windows zip)
Verify build instructions work from scratch
Add "Hello World" code example
Link to full documentation/tutorials

Structure

Quick start should be copy-paste runnable
Feature list should match current capabilities
Remove or update outdated information

Example Hello World

import mcrfpy

mcrfpy.createScene("hello")
ui = mcrfpy.sceneUI("hello")

caption = mcrfpy.Caption(text="Hello, Dungeon!", pos=(400, 300))
caption.fill_color = mcrfpy.Color(255, 255, 255)
ui.append(caption)

mcrfpy.setScene("hello")

#164 - Version should appear in README
#165 - Website should mirror README content
Tutorial demo game for more substantial examples

## Summary The README.md has placeholder content that needs to be filled in before public release. ## Current Issues 1. **Empty image placeholder**: `![ Image ]()` 2. **Blank download link**: `**Download**:` with nothing after 3. **Build instructions** reference `build_deps.tar.gz` that may not be published ## Tasks ### Content - [ ] Add real screenshot of McRogueFace in action - [ ] Add download links to releases (AppImage, Windows zip) - [ ] Verify build instructions work from scratch - [ ] Add "Hello World" code example - [ ] Link to full documentation/tutorials ### Structure - [ ] Quick start should be copy-paste runnable - [ ] Feature list should match current capabilities - [ ] Remove or update outdated information ### Links - [ ] Link to mcrogueface.github.io - [ ] Link to Forgejo issues for bug reports - [ ] Link to r/roguelikedev community ## Example Hello World ```python import mcrfpy mcrfpy.createScene("hello") ui = mcrfpy.sceneUI("hello") caption = mcrfpy.Caption(text="Hello, Dungeon!", pos=(400, 300)) caption.fill_color = mcrfpy.Color(255, 255, 255) ui.append(caption) mcrfpy.setScene("hello") ``` ## Related - #164 - Version should appear in README - #165 - Website should mirror README content - Tutorial demo game for more substantial examples

john added the

Documentation

label

2025-12-29 03:55:18 +00:00

john added a new dependency

2025-12-29 03:55:37 +00:00

2025-12-29 03:55:38 +00:00

john referenced this issue from a commit

2026-01-22 02:34:17 +00:00

README.md updates: closes #168

john closed this issue