diff --git a/README.md b/README.md index d7559f5..a4b0086 100644 --- a/README.md +++ b/README.md @@ -16,8 +16,22 @@ ### Getting Started * [STRATIMUX PROJECT TEMPLATE](https://github.com/Phuire-Research/STRATIMUX-TEMPLATE) -* [logixUX](https://github.com/Phuire-Research/logixUX) - User Interface MVP and Stratimux Project Sidekick Application +* [logixUX](https://github.com/Phuire-Research/logixUX) - User Interface MVP and Stratimux Project Sidekick Application, this will be decomposed into an advanced starter template and the concepts that allow for the user interface will be merged into this repository. + +### Concept Index +* [Action Strategy](https://github.com/Phuire-Research/Stratimux/blob/main/ActionStrategy.md) - Data structure that allows for Stratimux to be provably terminating. +* [Axium](https://github.com/Phuire-Research/Stratimux/blob/main/Axium.md) - Governing concept that contains the set of concepts that formalizes each axium. +* [Concept](https://github.com/Phuire-Research/Stratimux/blob/main/Concept.md) - Concepts are composed of state, qualities, principles, and mode. +* [Stage Planner](https://github.com/Phuire-Research/Stratimux/blob/main/StagePlanner.md) - Slices your application into different stages and prevents action overflows. +* [Action Controller](https://github.com/Phuire-Research/Stratimux/blob/main/ActionController.md) - Allows methods to be performed asynchronously. +* [Strategy Data](https://github.com/Phuire-Research/Stratimux/blob/main/StrategyData.md) - Enables the Action Strategy pattern to perform as a "Universal Transformer." +* [Data Oriented Functional Inheritance](https://github.com/Phuire-Research/Stratimux/blob/main/DataOrientedFunctionalInheritance.md) - Demonstrates "Unification of Concepts," as a method of functional inheritance. +* [Spatial Ownership](https://github.com/Phuire-Research/Stratimux/blob/main/SpatialOwnership.md) - A single lock concept that can be within a single process or network of axiums. + +### Want to learn more? * [PURF - White Paper](https://github.com/Phuire-Research/PURF) - Safe Recursive Improvement of AI +* [The Impossible Halting Turing Machine](https://github.com/Phuire-Research/Stratimux/blob/main/Index.md) - Original Paper for Stratimux +* [Unified Turing Machine](https://github.com/Phuire-Research/Stratimux/blob/main/The-Unified-Turing-Machine.md) - The governing concept for this entire framework. ## Change Log ![Tests](https://github.com/Phuire-Research/Stratimux/actions/workflows/node.js.yml/badge.svg) ### 11/29/23 @@ -38,11 +52,7 @@ ```bash npm i stratimux ``` -*Note if tsconfig.json is giving a type error for jest, be sure to open jest config after your **npm i*** - -For more examples: [https://github.com/Phuire-Research/Stratimux/tree/main/src/concepts](https://github.com/Phuire-Research/Stratimux/tree/main/src/concepts) -*Reminder:* This is a research project and while in a appropriate beta state. Some of aspects are bound to change, especially with the addition of more helper functions. ### Project Structure ``` src/ index.ts @@ -255,18 +265,16 @@ export const uXSomeStrategy = (): ActionStrategy => { ``` ### index.ts +Notice that beyond creating the axium, there is no need for additional input. As the axium is a recursive function. Your concepts are initialized internally via the principle that you have assigned to your concept. Note that you may still subscribe, stage, and dispatch actions into an axium. ```typescript import { createAxium } from 'stratimux'; import { createUXConcept } from './concepts/uX/uX.concept'; (() => { - const axiumName = ''; + const axiumName = 'Name of your axium'; // Sets logging to true and store dialog to true // This will log to the console the dialog of each successive ActionStrategy // And store the entire application context in the axium's dialog. createAxium(axiumName, [createUXConcept()], true, true); })(); -``` - -# The Original Paper -* [The Impossible Halting Turing Machine](https://github.com/Phuire-Research/Stratimux/blob/main/Index.md) \ No newline at end of file +``` \ No newline at end of file