Skip to content

Files

Failed to load latest commit information.

Latest commit

 Cannot retrieve latest commit at this time.

History

History

os

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

PrimeOS Operating System Layer

The os directory contains the high-level operating system modules for PrimeOS. These modules build upon the core axioms and kernel capabilities to provide practical functionality for applications and users.

Overview

The operating system layer serves as the interface between applications and the lower-level capabilities of PrimeOS. It provides standardized, practical utilities that most applications will need, built on the mathematical foundations of the core layer.

Modules

Model Module

The model module defines the standard pattern for all PrimeOS modules, establishing a consistent interface, lifecycle, and behavior. It's the foundation upon which other modules are built.

Logging Module

The logging module provides standardized logging capabilities for all PrimeOS components, with support for different log levels, formats, and destinations. It follows the model pattern for consistent integration with other modules.

Key features:

  • Log level filtering
  • Multiple output destinations
  • Structured logging
  • Performance monitoring
  • Integration with other PrimeOS modules

Testing Module (Planned)

The testing module will offer utilities for testing PrimeOS components, including mocks, assertions, and integration testing tools.

Modelling Module (Planned)

The modelling module will provide higher-level abstractions for defining and working with data models in PrimeOS applications, building on the core prime-based representation.

Integration Architecture

The OS layer modules are designed to work together seamlessly:

┌─────────────────────────────────────────────────────────────┐
│                       Applications                          │
└───────────────────────────┬─────────────────────────────────┘
                            │
┌───────────────────────────▼─────────────────────────────────┐
│                       OS Layer                              │
│                                                             │
│  ┌─────────────┐  ┌──────────┐  ┌─────────┐  ┌───────────┐  │
│  │    Model    │  │ Logging  │  │ Testing │  │ Modelling │  │
│  └─────────────┘  └──────────┘  └─────────┘  └───────────┘  │
└───────────────────────────┬─────────────────────────────────┘
                            │
┌───────────────────────────▼─────────────────────────────────┐
│                      Kernel Layer                           │
└───────────────────────────┬─────────────────────────────────┘
                            │
┌───────────────────────────▼─────────────────────────────────┐
│                       Core Layer                            │
└─────────────────────────────────────────────────────────────┘

Development Guidelines

When developing OS-layer modules:

  1. Follow the Model Pattern: All modules should implement the ModelInterface
  2. Consistent API Design: Follow established patterns for method naming and behavior
  3. Documentation: Include comprehensive README.md and code documentation
  4. Testing: Provide extensive test coverage
  5. Configurable: Support options for customizing behavior

Module Development Process

  1. Create the module using the template system:

    npm run create-module -- --name=module-name --path=os
    
  2. Define the interface in types.ts

  3. Implement the core functionality in index.ts

  4. Write tests in test.ts

  5. Document usage in README.md