Skip to content

Home

Jump to bottom
Joey Turner edited this page Jan 8, 2024 · 18 revisions

Framework

Refactoring

Overview

Configuring HW/SW Aspects of Armbian As developers, we aim to refactor the framework for configuring hardware (HW) and software (SW) aspects of Armbian. The goal is to achieve a modular, parameter-driven Command Line Interface (CLI), dialog, and X-based engine. We also aim to provide help for each command accessible from both CLI and menus, implement a mechanism for automated functionality testing, enable software deployment with GitHub actions, and maintain a modular design that facilitates the addition of new software titles or functionality.

User Perspective

As an end user, the functions will be categorized into three levels:

  • Basic: Core functions only
  • Intermediate: Functions in the middle
  • Advanced: Exposed all functions

This approach ensures that users do not need to think more than necessary, providing a streamlined experience.

Proposed Features

  1. Parameter-Driven CLI, Dialog, and X-Based Engine

    • Implement parameter-driven CLI
    • Develop dialog-based engine
    • Create an X-based engine

  2. Help Mechanism

    • Provide help for each command in the CLI
    • Implement a help system accessible via menus

  3. Automated Functionality Testing

    • Define and set up a mechanism for automated functionality testing

  4. Software Deployment

    • Enable software deployment

  5. Modular Design

    • Design a modular architecture
    • Ensure ease of adding new software titles or functionality

Milestones

Milestone 1: CLI and Basic Functionality

  • Parameter-driven CLI
  • Help for basic commands
  • Core functionality for basic level users

Milestone 2: Dialog and Intermediate Features

  • Dialog-based engine
  • Help accessible from menus
  • Intermediate-level functionality

Milestone 3: X-Based Engine and Advanced Features

  • X-based engine
  • Help accessible from CLI
  • Advanced-level functionality

Milestone 4: Automated Testing and Deployment

  • Mechanism for automated functionality testing
  • Software deployment with Ansible GitHub actions

Milestone 5: Modular Design

  • Modular architecture in place
  • Ease of adding new software titles or functionality

Additional Notes

Clone this wiki locally