Skip to content

getting-started.md

Latest commit

 

History

History
91 lines (63 loc) · 2.04 KB

getting-started.md

File metadata and controls

91 lines (63 loc) · 2.04 KB
Raw

Getting Started with UBuilder

UBuilder is a cross-platform solution that packages applications written in various programming languages as single, dependency-free executables.

Installation

From Source

  1. Prerequisites

    • CMake 3.16 or higher
    • C/C++ compiler (GCC, Clang, or MSVC)
    • Git

  2. Clone and Build

    git clone <repository-url>
cd ubuilder
chmod +x build-system/build.sh
./build-system/build.sh

  3. Verify Installation

    ./dist/bin/ubuilder --version
./dist/bin/ubuilder --help

Quick Start

Building Your First Application

  1. Create a simple Python application

    # hello.py
print("Hello from UBuilder!")

  2. Build with UBuilder

    ./dist/bin/ubuilder --project-dir=./my-project \
                    --runtime=python \
                    --entry-point=hello.py \
                    --output=hello-app

  3. Run the executable

    ./hello-app

Supported Runtimes

  • Python: Package Python scripts and applications
  • PHP: Package PHP CLI applications
  • Node.js: Package Node.js applications

Basic Usage

ubuilder --project-dir=<path> --runtime=<runtime> --output=<name> [options]

Required Arguments:

  • --project-dir: Source project directory
  • --runtime: Runtime type (python, php, node)
  • --output: Output executable name

Optional Arguments:

  • --entry-point: Application entry point file
  • --gui: Enable GUI support
  • --verbose: Enable verbose output

Examples

See the examples directory for complete example applications:

Next Steps