diff options
| author | _ov4 <ov4@ov4.org> | 2026-10-20 01:27:14 +0000 |
|---|---|---|
| committer | _ov4 <ov4@ov4.org> | 2026-10-20 01:27:14 +0000 |
| commit | 7a090c08a7406c3bd364ee78e0f8a581c29e58a6 (patch) | |
| tree | 3b8c5aac5bb7b0d4db90a6299e43976a1f65a2dc | |
| parent | 6526f7dac704d73d615159e834af8f83a26ab8d7 (diff) | |
docs(readme): align feature and nightly release descriptions
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
| -rw-r--r-- | README.md | 4 | ||||
| -rw-r--r-- | plugin/README.md | 4 | ||||
| -rw-r--r-- | tests/README.md | 2 |
3 files changed, 6 insertions, 4 deletions
@@ -20,13 +20,15 @@ Details can be found here: [Pseudocode Guide for Teachers](https://www.cambridge - **Functions and procedures**: Pass values, arrays and records by value; procedures also support `BYREF` parameters. - **Text files**: Support `OPENFILE`, `READFILE`, `WRITEFILE`, `CLOSEFILE` and `EOF`. - **User-defined types**: Support enumerated types, pointers and nested records. +- **Classes**: Support public/private fields and methods, constructors, destructors, copying and operator overloads. +- **Selection and constants**: Support `CASE OF` branches and named literal `CONSTANT` values. ## TODO - **Source TODOs**: Resolve remaining `TODO` comments. - **Random files**: Add `OPENFILE FOR RANDOM`, `SEEK`, `GETRECORD` and `PUTRECORD`. - **Set types**: Implement `SET` and `DEFINE`. -- **Other syntax**: Add `CASE OF`, `CONSTANT` and `DATE`. +- **Other syntax**: Add `DATE`. ## Note diff --git a/plugin/README.md b/plugin/README.md index ec21fb7..88ddd4c 100644 --- a/plugin/README.md +++ b/plugin/README.md @@ -6,7 +6,7 @@ VS Code support for this project's `.cps` files. Requires VS Code 1.85 or newer ## Install -Download the VSIX from [Nightly Build](https://github.com/ovfor4/cie-pseudocode-compiler/releases/tag/nightly-build). The same release provides Linux x86_64 and macOS 15+ Apple Silicon compiler packages with execution support. +Download the VSIX from [Nightly Build](https://github.com/ovfor4/cie-pseudocode-compiler/releases/tag/nightly-build). The same release provides Linux x86_64, Windows x86_64 and macOS 15+ Apple Silicon compiler packages with execution support. If you installed the old extension (`ovfor4.cie-pseudocode`), uninstall it before installing `ovfor4.plugin`. Update any explicit `editor.defaultFormatter` setting to `ovfor4.plugin`. @@ -30,6 +30,6 @@ Install `cpsc` with execution support and add it to PATH, or set **CIE Pseudocod The terminal takes focus so you can answer `INPUT`. Relative file paths use the file's workspace root, or its own directory when no workspace is open. The terminal is reused; stop a running program with **Ctrl+C** before running again. -Use uppercase keywords, `<-` for assignment and `//` for comments. Support matches the current compiler. +Use uppercase keywords, `<-` for assignment and `//` for comments. Editor support covers a subset of compiler syntax: CASE and CLASS blocks lack indentation support, string escapes are not recognized, and WHILE indentation still expects DO. These editor limitations do not prevent the compiler from running supported programs. See [examples/highlighting.cps](examples/highlighting.cps) for an example. diff --git a/tests/README.md b/tests/README.md index ab05c48..bc05b18 100644 --- a/tests/README.md +++ b/tests/README.md @@ -26,7 +26,7 @@ Use the actual SHA from a failed report in place of `FULL_COMMIT_SHA`. Clear `CP `build/test-results/<suite>/<case>/` contains `result.json`, numbered command metadata, stdin/stdout/stderr, expected output and isolated work directories. Random mismatches also save the first differing record. A case may include `expected-stderr.txt` for the runtime diagnostics written to stderr; without it stderr must be empty. Re-running a case replaces only that case's directory; summaries include any other retained results, so remove `build/test-results` before collecting a fresh full-suite report. Commands have finite timeouts (30 seconds normally, 120 for compilation, 180 for file-intensive executions); timeout and launch/crash failures fail the case. -In Actions, each compiler platform runs all three suites and summarizes results before its existing package smoke checks and upload. Failures retain inputs and logs as an Actions artifact for 14 days. Each platform publishes only after its own tests pass. The initial Linux failures have been fixed; any failing compiler test still blocks publication for that platform. The independent plugin job can publish separately. +In Actions, each compiler platform runs all three suites and summarizes results before its package smoke checks and artifact upload. Failures retain inputs and logs as an Actions artifact for 14 days. A final publish job updates the nightly release attachments only after all three compiler jobs and the plugin job succeed. Any build or check failure leaves the previous attachments untouched. For adding cases and runner interfaces, see [AGENTS/TESTING.md](../AGENTS/TESTING.md). |
