Skip to content

DoorOS-Project/os-build-utility

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OS Build Utility

OS Build Utility is a command-line tool developed by the DoorOS Project designed to simplify the building and running of operating systems. This tool automates compilation, and execution tasks, enhancing efficiency in OS development.

Installation

  1. Download the Pre-built Binary: Obtain the latest release from the Releases page.

  2. Extract and Install: Follow the installation instructions provided with the release assets.

Usage

The OS Build Utility command supports the following usage format:

os-build-utility [[--configure | -c] | [[--build | -b] [--run | -r]]] [--force | -f]

Options

  • Configure the Tool: Set up build and run commands interactively.

    os-build-utility [--configure | -c]
  • Build the OS: Compile the operating system.

    os-build-utility [--build | -b]
  • Run the OS: Execute the operating system.

    os-build-utility [--run | -r]
  • Build and Run the OS: Perform both build and run operations. Use --force to don't exit on build or run fail.

    os-build-utility [--build --run | -b -r | -br]

Build Instructions

To build the tool from source:

  1. Clone the Repository:

    git clone https://github.com/DoorOS-Project/os-build-utility.git
  2. Navigate to the Project Directory:

    cd os-build-utility
  3. Build the Tool:

    make

.os-build-utility.conf File specifications

The .os-build-utility.conf file is the configuration file for OS Build Utility. It contains the build command for your OS (the first non-empty and non-commented line) and the run command (the second non-empty and non-commented line), and the run command for you OS (the third non-empty and non-commented line). Each line where the first non-whitespace character is a # is considered as a comment. The %cd% is a special variable that will be replaced by the current directory path.

License

OS Build Utility is licensed under the GNU General Public License v2.0. Please refer to the LICENSE file for detailed licensing information.

Contributing

We welcome contributions to OS Build Utility. To suggest improvements, report issues, or submit code changes, please use the following links: