From: Thomas Walker Lynch <eknp9n@reasoningtechnology.com>
Date: Wed, 14 May 2025 15:05:47 +0000 (-0700)
Subject: new README
X-Git-Url: https://git.reasoningtechnology.com/usr/lib/python2.7/encodings/shift_jisx0213.py?a=commitdiff_plain;h=90649d1b69836b2d9720a6ca8fd95310c22defa7;p=RT-gcc

new README
---

diff --git a/README.md b/README.md
index 6655a4e..3f9ed9a 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,111 @@
-# Standalone GCC Installation with option for RT mods.
+# Standalone GCC Installation with Option for RT Mods
 
-As of 2025-05-04:
-* Based on GCC 15.1.0
-* I'm still tweeking the standalone scripts.
-* Have not yet integrated any of the RT mods.
+As of 2025-05-14:
 
-## Standalone build
+* Based on GCC 12.4.1
+* Builds on Debian 12
+* Standalone toolchain build scripts are functional and modular
+* Includes `#macro` and `#assign` directive support (RT extensions)
 
-For those who desire to watch the chips stand where they may:
+---
 
-```
+## Standalone Build
+
+For those who wish to let the chips fall where they may:
+
+```bash
 > source env_toolsmith
 > ./build_all.sh
 ```
 
-Otherwise read `build_all.sh` and follow the steps.
+Alternatively, read through `build_all.sh` and follow its logic step by step.  
+Environment variables are defined in `script🖉/environment.sh` — this file guides where and how components are installed.
 
-Note the file 'script🖉/environnment.sh' for the variables that guide the installation.
+---
 
-## The `#assign` directive.
+## The `#macro` and `#assign` Directives
 
-Requires running:
+These are two experimental extensions to the C preprocessor (CPP), part of the **RT Extensions**.
 
-```
+To enable them:
+
+```bash
 > source env_toolsmith
 > ./apply_RT_assign_directive_mod
 > ./build_all.sh
 ```
 
+(At the moment manually copy the directives.cc and macro.cc files back into the source.)
+
+---
+
+### `#macro`
+
+Defines a macro in standard ISO form, using token literal parsing and optional parameter substitution. Equivalent to a cleaner `#define`, with controlled multi-line support and macro parameter semantics.
+
+#### Syntax (EBNF):
+
+```
+directive     ::= "#macro" name params body ;
+
+name          ::= identifier ;
+
+params        ::= "(" param_list? ")" ;
+param_list    ::= identifier ("," identifier)* ;
+
+body          ::= clause ;
+
+clause        ::= "(" literal? ")" 
+                | "[" expr? "]" ;
+
+literal       ::= ; sequence parsed into tokens without expansion
+expr          ::= ; sequence parsed into tokens with recursive expansion
+
+; whitespace, including newlines, is ignored
+```
+
+- A `literal` clause is delimited with `(` ... `)` and behaves like `#define F(x) (x + 1)`.
+- An `expr` clause is delimited with `[` ... `]` and expands tokens as they are parsed.
+
+If you need an unbalanced parenthesis in the macro, define it to a macro, then include the macro.
+
+#define OPEN (
+#assign X() ( OPEN )
+
+---
+
+### `#assign`
+
+Assigns a macro dynamically. It differs from `#macro` by:
+- Accepting a **macro name expression** (`name_clause`) which may itself be an expansion
+- Accepting a **macro body expression**, optionally with recursive expansion
+- Allowing runtime reassignment of macro behavior
+
+_This enables construction of self-modifying or symbolic macros within a source file._
+
+**Note:** `#assign` currently supports expression-based bodies but does not include parameter binding.
+
+#### Syntax (EBNF):
+
+    cmd        ::= "#assign" name body ;
+
+    name       ::= clause ;
+    body       ::= clause ;
+
+    clause     ::= "(" literal? ")" | "[" expr? "]" ;
+
+    literal    ::= ; sequence parsed into tokens
+    expr       ::= ; sequence parsed into tokens with recursive expansion of each token
+
+    ; white space, including new lines, is ignored.
+
+     This differs from `#define`:
+       -name clause must reduce to a valid #define name
+       -the assign is defined after the body clause has been parsed
+
+---
+
 ### License
 
-The code in this project is released under the **MIT License**, see the LICENSE.text file for details.
+This project is licensed under the **MIT License**.  
+See the `LICENSE.text` file for full terms.