added some docs

diff --git a/LICENSE b/LICENSE
index 4c9ac81..c44a91a 100644 (file)
--- a/LICENSE
+++ b/LICENSE
@@ -1,5 +1,21 @@
-Copyright (c) 2025 Thomas Walker Lynch.
-All rights reserved.
+MIT License
 
-This source code is made available for inspection only.
-No permission is granted to use, copy, modify, or distribute it in any form without explicit written permission.
+Copyright (c) 2025 Reasoning Technology
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

diff --git a/document/.githolder b/document/.githolder
new file mode 100644 (file)
index 0000000..e69de29

diff --git a/document/Workflow.org b/document/Workflow.org
new file mode 100644 (file)
index 0000000..7918ae4
--- /dev/null
+++ b/document/Workflow.org
@@ -0,0 +1,86 @@
+#+TITLE: RT Project Workflow (Spartan)
+#+AUTHOR: RT
+#+OPTIONS: toc:2 num:nil
+
+* Purpose
+Lightweight workflow for RT projects using the Harmony skeleton. Roles are simple; releases are branches. Keep friction low so we can ship.
+
+* Roles
+** 1) Toolsmith
+- Sets up the skeleton
+- Populates shared tools
+- Maintains those tools
+
+** 2) Developer
+- Translates the spec into code
+- Evolves the code iteratively
+
+** 3) Tester
+- Writes unit tests for small functions
+- Writes integration tests
+- Assembles and runs the regression suite
+- *Policy:* every reported bug gains a test in the regression suite
+
+** 4) Project Manager
+- Aligns on “what is working and how well”
+- Confirms readiness to cut a release branch (with the team)
+
+* How to enter the project
+1) =cd= to the project root  
+2) Source the proper environment (e.g., =. env_developer=)  
+3) Run tools *inside that environment*
+
+* Release flow
+** The little loop
+The =core_developer_branch= is the moving head under active development.
+
+- =\$REPO_HOME/release= holds *current candidates under test* (convenience staging).
+- Loop:
+  1. Architect and PM, maintain the “required + desired” feature manifest.
+  2. Architect sketches the outline (expect it to evolve).
+  3. Developers implement features.
+  4. Developers drop candidates into =$REPO_HOME/release=.
+  5. Tester exercises candidates, files bugs, and adds tests to the regression suite.
+  6. Developers address issues and produce new candidates.
+  7. Repeat until candidates are sufficiently functional and reliable.
+
+Developers may keep personal experiments under =developer/=. These are not written for repeatability like tests; though they might seed future tests.
+
+** The big loop
+When candidates in =$REPO_HOME/release= are sufficiently functional and stable—and the PM agrees on “what is working and how well”—*cut a release branch*.
+
+- *Name*: =release_v<n>= where =n= is the next consecutive integer (starting at 1).
+- *Create*:
+  #+begin_src sh
+  git checkout core_developer_branch
+  git pull --ff-only
+  git branch release_v3
+  git push reasoning_repo release_v3
+  git push github_repo    release_v3
+  #+end_src
+- After this, the release branch “takes on its own life.”
+
+If a non-urgent bug is found on the shipped line:
+- Fix it on =core_developer_branch= for the next release (backport to the release if truly needed).
+- Due to the bug getting a regression test, the core developers will not forget it.
+
+If an urgent fix is needed on the shipped line:
+- Apply the fix on =release_v<n>=, then cut =release_v<n.m>= where =m= is the next consecutive modification number (starting at 1).
+- As always, *add a regression test* for the bug.
+
+* Deprecation
+New major releases *deprecate prior releases*. Maintainers decide any support window.
+
+* Do / Don’t
+- *Do*: fast-forward pulls on release branches; keep history linear.
+- *Do*: keep fixes small and targeted.
+- *Don’t*: rebase release branches.
+- *Don’t*: routinely merge the moving core branch into a release line.
+
+* Notes
+- Tags are not required in this spartan flow (use only if your distribution channel needs them).
+- Consider server-side protection on =release_v*= branches to prevent force-pushes.
+- Typical remotes: =reasoning_repo= (internal) and =github_repo= (GitHub). Substitute if yours differ.
+
+* One-liner mental model
+Core keeps moving; releases branch off and live their own lives. If everyone uses Harmony, we all live in peace. :)

diff --git a/document/general_info.org b/document/general_info.org
new file mode 100644 (file)
index 0000000..054d3f6
--- /dev/null
+++ b/document/general_info.org
@@ -0,0 +1,8 @@
+
+This project is based on the Harmony skeleton, read more about it in Harmony/document
+on github. Also see RT-project-share.
+
+The Harmony/document/convention/Workflow.org document has been copied here, as it
+explains how to use the Harmony skeleton.
+
+

diff --git a/scratchpad/.gitignore b/scratchpad/.gitignore
new file mode 100644 (file)
index 0000000..120f485
--- /dev/null
+++ b/scratchpad/.gitignore
@@ -0,0 +1,2 @@
+*
+!/.gitignore