Formatting change

Author: t81dev

CONTRIBUTING.md

@@ -0,0 +1,24 @@
+# Contributing to Ternary GCC Plugin
+
+## How to Contribute
+
+1. Fork the repository.
+2. Create a feature branch.
+3. Make your changes and add any new tests or helpers.
+4. Run `make test` (and `make check-helper-docs` if you touched the helper ABI).
+5. Submit a PR with a concise description of the behavioral changes and any test results.
+
+## Guidelines
+
+- Follow GCC plugin best practices.
+- Run `tools/check_helper_docs.py` (via `make check-helper-docs`) whenever you add or update helpers so the documentation stays in sync with `include/ternary_runtime.h`.
+- Add regression tests whenever the helper ABI or runtime behavior changes.
+- Reference the updated README sections when describing functionality and compatibility.
+
+## Building with CMake
+
+```bash
+mkdir build && cd build
+cmake ..
+make
+```

README.md

@@ -0,0 +1,9 @@
+# Documentation Index
+
+The repository README now lives at [`../README.md`](../README.md) so that visitors landing at the root get the full guide. This folder continues to hold supplemental documents listed below.
+
+- [docs/CONTRIBUTING.md](CONTRIBUTING.md)
+- [docs/ROADMAP.md](ROADMAP.md)
+- [docs/SPECIFICATION.md](SPECIFICATION.md)
+- [docs/MASTER_ISA.md](MASTER_ISA.md)
+- [docs/ENCODING.md](ENCODING.md)

docs/CONTRIBUTING.md

@@ -41,10 +41,12 @@ Deliverables:
 - Expand lowering to cover all defined intrinsics and ternary ops.
 - Ensure safe handling for unsupported types and conditions.
 - Add diagnostics for unsupported or ambiguous cases.
+- Track Phase 3/4 regression coverage (lowering + diagnostics) with a dedicated script/log so each milestone emits a clear artifact.
 
 Deliverables:
 - Plugin coverage test suite in `tests/`.
 - GIMPLE-based regression tests (golden output or dg tests).
+- `tests/run_phase34_coverage.sh` + `tests/PHASE34_COVERAGE.md` document the targeted entries and log file for upcoming checkpoints.
 
 ## Phase 4: Optimization and Codegen Validation
 
@@ -82,7 +84,8 @@ Deliverables:
 - Document supported platform/compiler versions and current status.
 - Add ABI validation checks in CI (symbol presence or hash).
 - Ensure the documented helper ABI (`SPECIFICATION.md`/README) stays aligned with the headers
-  (`include/ternary_runtime.h`, `include/ternary_helpers.h`), ideally via a CI regression.
+  (`include/ternary_runtime.h`, `include/ternary_helpers.h`), ideally via a CI regression triggered by
+  `tools/check_helper_docs.py` so README/SPEC restructure stays aligned with the header order.
 
 Deliverables:
 - Compatibility matrix in `README.md`.

ENCODING.md docs/ENCODING.mdENCODING.md renamed to docs/ENCODING.md

@@ -447,6 +447,8 @@ helper implementations can be shared between plugin tests and downstream runtime
   `__ternary_tt2b_t64`, `__ternary_t2f32_t32`, `__ternary_t2f32_t64`, `__ternary_t2f64_t32`,
   `__ternary_t2f64_t64`, `__ternary_f2t32_t32`, `__ternary_f2t32_t64`, `__ternary_f2t64_t32`,
   `__ternary_f2t64_t64`.
+- **Conversion helpers (t128, when `_BitInt(256)` is available)**:
+  `__ternary_tb2t_t128`, `__ternary_tt2b_t128`.
 - **Memory helpers**: `__ternary_load_t32`, `__ternary_store_t32`, `__ternary_load_t64`,
   `__ternary_store_t64`.
 - **Vector SIMD helpers**: `__ternary_add_tv32`, `__ternary_sub_tv32`, `__ternary_mul_tv32`,

MASTER_ISA.md docs/MASTER_ISA.mdMASTER_ISA.md renamed to docs/MASTER_ISA.md

@@ -6,7 +6,7 @@
  * Adjust the assembly to match your actual ISA and calling convention.
  *
  * The Setun ISA and modern REBEL-6 work inspired the helpers below. When possible prefer
- * the ternary-only ops listed in MASTER_ISA.md (three-valued implication, majority voting,
+ * the ternary-only ops listed in ../docs/MASTER_ISA.md (three-valued implication, majority voting,
  * TMIN/TMAX, TQUANT, TMULADD, and symmetric rounding) instead of emulating them with
  * binary sequences. These helpers stay compatible with the GCC plugin ABI and are intended
  * to survive into hardware-friendly implementations.

docs/README.md

@@ -164,6 +164,8 @@ t128_t __ternary_tmux_t128(t128_t sel, t128_t neg, t128_t zero, t128_t pos);
 t128_t __ternary_tequiv_t128(t128_t a, t128_t b);
 t128_t __ternary_txor_t128(t128_t a, t128_t b);
 int __ternary_tnet_t128(t128_t a);
+int64_t __ternary_tt2b_t128(t128_t v);
+t128_t __ternary_tb2t_t128(int64_t v);
 #endif
 
 /* Ternary-specific comparison operations for t64 (return ternary results) */