Skip to content

Add English documentation and getting started guide#1

Draft
Copilot wants to merge 4 commits intomasterfrom
copilot/check-project-status-guidelines
Draft

Add English documentation and getting started guide#1
Copilot wants to merge 4 commits intomasterfrom
copilot/check-project-status-guidelines

Conversation

Copy link
Copy Markdown

Copilot AI commented Feb 18, 2026

The project lacked English documentation for international developers. Chinese documentation exists (hu.md, ai.md) but no onboarding guide for English speakers.

Changes

  • GETTING_STARTED.md: Comprehensive guide covering installation, API usage, card numbering system, and lookup table mechanics
  • README.md: Added English overview, quick start examples, feature highlights, and documentation links
  • .gitignore: Excludes Maven build artifacts

Usage Example

// Load lookup tables
HuTable.load(Files.readAllLines(Paths.get("majiang_clien_normal.txt")));
HuTableFeng.load(Files.readAllLines(Paths.get("majiang_clien_feng.txt")));
HuTableJian.load(Files.readAllLines(Paths.get("majiang_clien_jian.txt")));

// Check win conditions
boolean canWin = HuUtil.isHu(cards, gui);
List<Integer> tingCards = HuUtil.isTing(cards, gui);

// AI recommendations
int discard = AIUtil.outAI(cards, gui);

The library provides Mahjong win detection and AI algorithms using pre-computed lookup tables for performance.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits February 18, 2026 20:43
Co-authored-by: guanzhousongmicrosoft <85122868+guanzhousongmicrosoft@users.noreply.github.com>
Co-authored-by: guanzhousongmicrosoft <85122868+guanzhousongmicrosoft@users.noreply.github.com>
Co-authored-by: guanzhousongmicrosoft <85122868+guanzhousongmicrosoft@users.noreply.github.com>
Copilot AI changed the title [WIP] Check project status and add setup guide Add English documentation and getting started guide Feb 18, 2026
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.

2 participants