Skip to content

Add feature details in README#88

Open
kjw142857 wants to merge 6 commits into
mainfrom
docs-update
Open

Add feature details in README#88
kjw142857 wants to merge 6 commits into
mainfrom
docs-update

Conversation

@kjw142857
Copy link
Copy Markdown
Contributor

@kjw142857 kjw142857 commented Mar 11, 2026

Updates READMEs to:

  • Include current features implemented in java-slang
  • Include unimplemented/planned features
  • Include clarification of compiler usage in web-based version of SA
  • Add testing guide for compiler

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 11, 2026

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements 73.95% 7176/9704
🟡 Branches 60.39% 2356/3901
🟡 Functions 69.45% 1287/1853
🟡 Lines 74.89% 6755/9020

Test suite run success

1120 tests passing in 63 suites.

Report generated by 🧪jest coverage report action from 668d673

@kjw142857 kjw142857 changed the title Add details in README Add feature details in README Mar 11, 2026
@kjw142857 kjw142857 marked this pull request as ready for review March 17, 2026 23:50
Comment thread src/compiler/README.md
@@ -1,5 +1,7 @@
This is a bookkeeping of the planned scope of the compiler. It will be updated from time to time to reflect the current status of the compiler and to make the scope clearer. For a more formal treatment of what features are being supported, see scope.txt for a BNF-form of the Java sub-language.

Note that the compiler is separate from the Java Playground in Source Academy, which runs in tandem with the ECE. As such, any program run in the Playground will follow the features implemented in the ECE (e.g. widening type conversions), rather than the features below.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The compiler+typecheck->JVM toolchain is the default execution in js-slang. The CSEC machine doesn't need to be mentioned here. It is an additional optional visualization tool.

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