Skip to content

Improve charmodelling README with setup instructions and usage guide#1099

Open
NA-V10 wants to merge 3 commits intodeeplearning4j:masterfrom
NA-V10:improve-charmodelling-readme
Open

Improve charmodelling README with setup instructions and usage guide#1099
NA-V10 wants to merge 3 commits intodeeplearning4j:masterfrom
NA-V10:improve-charmodelling-readme

Conversation

@NA-V10
Copy link
Copy Markdown
Contributor

@NA-V10 NA-V10 commented Mar 29, 2026

What changes were proposed in this pull request?

This pull request improves the charmodelling README by making it easier for beginners to understand and run the example.

Changes include:

  • Added prerequisites section
  • Added quick start instructions
  • Added main classes overview
  • Added run commands with Maven examples
  • Added expected output section
  • Reorganized content for better readability

How was this patch tested?

This patch was tested manually by:

  • Verifying markdown formatting and heading structure
  • Checking that all code blocks render correctly
  • Confirming Maven commands match the existing package structure
  • Reviewing links and section ordering for readability
  • Previewing the README to ensure proper formatting on GitHub

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