Skip to content
This repository has been archived by the owner on Jan 12, 2022. It is now read-only.

Latest commit

 

History

History
95 lines (61 loc) · 4.08 KB

README.md

File metadata and controls

95 lines (61 loc) · 4.08 KB
Raw

THIS PROJECT IS DEPRECATED AND REPLACED BY aoscdk-rs.

AOSC OS DeployKit

The new installation and recovery utility for AOSC OS.

This repository contains the reference implementation of DeployKit frontend. The backend of DeployKit is at AOSC-Dev/libaoscdk.

Features

(Some of the following features are still under development, so stay tuned!)

  • Choose, customize, and install AOSC OS with a straightforward graphical user interface
  • Offering "general" mode for newcomers and "expert" mode for power users
  • Providing command line inerface (CLI) for batch operation and terminal lovers
  • Search and restore your AOSC OS backups
  • Repair your AOSC OS installation

DeployKit is designed to be used with LiveKit, which is the new, planned pre-installation environment of AOSC OS. When DeployKit is used with LiveKit, it can perform various offline operations to the AOSC OS installation on a local disk / partition.

DeployKit is still in its early stage of development, and you're welcomed to contribute to this project!

Supported Platform

So far: LiveKit only. (See above)

Dependencies

To build DeployKit, the following build dependencies are required:

  • The Vala compiler (valac)
    • To build the HTML API reference, valadoc is also required, which is shipped with the Vala compiler, but may not on some Linux distributions
    • Since Vala transpiles to C, a C compiler (e.g. GCC) is also required to produce binary object files and the final executable
  • The Meson build system (meson)

The following libraries are required both during compile-time and run-time:

  • GLib 2.x (glib-2.0): The very fundamental library used in software written in Vala
    • Along with GObject 2.x (gobject-2.0, the GLib object system) and GIO 2.x (gio-2.0, the GLib input / output system), which are usually shipped with GLib
  • LibGee 0.8+ (libgee-0.8): The GObject-based data structure library for Vala
  • JSON-GLib 1.x (json-glib-1.0): The GObject-based JSON parsing and generating library
  • LibSoup 2.4+ (libsoup-2.4): The GObject-based HTTP(S) client / server
  • LibUDisks 2.x (udisks2): The GObject-based library for accessing the UDisks storage manager
  • GTK 3.20+ (gtk+-3.0): The famous toolkit for building nice graphical user interfaces

Build

Use Meson:

mkdir build && cd build

# Use meson to configure the project
meson ..

# Use ninja to build the project (parallel build by default)
ninja

Options can be set with meson to customize the build:

  • -Dbuild_gui=false to opt-out the GUI frontend of DeployKit (CLI only)
  • -Dbuild_tests=false to avoid building unit tests to reduce build time
  • -Dbuild_docs=false to disable HTML documentation build using valadoc
  • More to come...

Translate

DeployKit uses GNU Gettext to implement internationalization (i18n) / localization (l10n) support. The build system has already integrated Gettext support, so you don't need to know much about the command line tools of Gettext.

The POT template file is not in the version control system. To get DeployKit localized into your mother tongue, first extract all translatable strings into a .pot file, and then generate the PO files containing all strings ready for translation. After translation, generate the MO files, which are used by the Gettext runtime to efficiently translate UI strings on-the-fly.

mkdir build && cd build

# Use meson to configure the project first
meson ..

# Generate POT (in $srcdir/po)
ninja aosc-dk-pot

# Generate PO files ready for translation (in $srcdir/po)
ninja aosc-dk-update-po

# Compile PO files into MO files ready for binary integration (in $bindir/po)
ninja aosc-dk-gmo

If the LINGUAS file does not contain your language, add the language tag into it and re-generate PO files. Submit PO files only after translation is finished.

License

This project is licensed under the MIT license. See COPYING for details.