Skip to content

Codex/repo setup docs#6

Merged
autibet merged 11 commits intomainfrom
codex/repo-setup-docs
Feb 22, 2026
Merged

Codex/repo setup docs#6
autibet merged 11 commits intomainfrom
codex/repo-setup-docs

Conversation

@SeaCelo
Copy link
Copy Markdown
Collaborator

@SeaCelo SeaCelo commented Feb 21, 2026

Summary

This PR sets up the repository for outside contributors before major code work starts. It improves clarity, reduces onboarding friction, and defines a simple contribution workflow. There are no functional code changes.

What this PR changes

  1. Rewrites README.md to be shorter and easier for new users.
  2. Clearly states this repo is downstream from OSeMOSYS/MUIO and maintained independently.
  3. Explains current usage path:
    • Windows users can use the existing .exe workflow.
    • Mac users can use SeaCelo/MUIO-Mac for now.
  4. States long-term goal: make MUIOGO platform independent so a separate Mac port is no longer needed.
  5. Makes contribution flow explicit: open an issue first, then work from a feature branch.
  6. Updates supporting docs and PR guidance for consistency.

Solves #5

@autibet

@SeaCelo SeaCelo requested a review from autibet February 21, 2026 19:50
@SeaCelo SeaCelo added the documentation Improvements or additions to documentation label Feb 21, 2026
@autibet autibet merged commit 50d4072 into main Feb 22, 2026
@SeaCelo SeaCelo deleted the codex/repo-setup-docs branch February 25, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants