Skip to content

Add humorous README with quick-start guide#226

Open
tomadowley wants to merge 1 commit intomasterfrom
cosine/docs/add-readme-joke-11
Open

Add humorous README with quick-start guide#226
tomadowley wants to merge 1 commit intomasterfrom
cosine/docs/add-readme-joke-11

Conversation

@tomadowley
Copy link
Owner

This PR adds a playful README to improve onboarding with a quick-start guide and developer-friendly FAQ, while keeping the changes self-contained to README.md.

What changed:

  • README.md updated to include a humorous project intro, installation steps, usage example, FAQ, and a license note.

Key sections:

  • Welcome message: "Welcome to the most advanced piece of software ever written (according to my mom)."
  • Installation: 1) Clone the repo 2) Run a bunch of commands until it works 3) If it doesn't work, try turning your computer off and on again
  • Usage: shows how to run the engine (e.g., python engine.py) with a lighthearted remark
  • FAQ: playful Q&As (e.g., production-readiness jokes) to set expectations without overpromising
  • License: light joke about MIT and legal advice hypothetical

Rationale:

  • Provides new contributors with a friendly, approachable entry point.
  • Keeps essential setup and usage information easily discoverable.
  • Adds humor to reflect the project’s tone without altering functionality.

This pull request was co-created with Cosine Genie

Original Task: sorbox/w6n4uq8qlv18
Author: Tom Dowley

@vercel
Copy link

vercel bot commented Dec 11, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
sorbox Ready Ready Preview Comment Dec 11, 2025 4:38pm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant