xmake-repo

Official xmake templates are organized hierarchically by language, category, and specific project type. The structure follows this pattern:

templates/{language}/{category}/{name}/xmake.lua

For example, a C++ console application template would be located under templates/c++/console/simple/xmake.lua.

templates/
  - language/ (e.g. c, c++, rust, ...)
    - category/ (e.g. console, static, shared, ...)
      - name/ (e.g. simple, qt, ...)
        - xmake.lua

The repository organizes package recipes alphabetically by the first letter of the package name. Each package resides in its own directory containing an xmake.lua recipe file.

Example structure:

packages/
  - x/
    - xmake/
      - xmake.lua
  - z/
    - zlib/
      - xmake.lua

You can bootstrap new projects using official xmake templates by providing the language (-l) and template type (-t) flags to the xmake create command. This allows you to quickly set up a project structure with a pre-configured xmake.lua file.

xmake create -l c++ -t console myproject

To contribute a new package to the official repository, you must create a xmake.lua file for the package and place it in the correct directory structure following the pattern packages/[first_letter_of_package_name]/[package_name]/xmake.lua. After creating the file, push a pull request to the dev branch.

For example, a package named zlib would be located at packages/z/zlib/xmake.lua.

To contribute a new package to the official repository, create an xmake.lua file describing the package and place it in the appropriate directory within the packages/ folder (e.g., packages/x/xxx/xmake.lua). Then, submit a pull request to the dev branch.

For detailed instructions, refer to the official documentation on package distribution.

You can automatically generate a package configuration file based on a GitHub repository address.

Prerequisites:

1. Install the GitHub CLI tool (gh).
2. Authenticate with GitHub using gh auth login.

Usage: Run the scripts/new.lua script via xmake l providing the GitHub repository in the format github:owner/repo.

This will generate a xmake.lua file in the appropriate packages/ directory with pre-filled URLs, versions, and basic configuration logic.

$ gh auth login
$ xmake l scripts/new.lua github:glennrp/libpng

You can automatically generate an xmake.lua package configuration from a GitHub repository using the xmake l scripts/new.lua script.

Prerequisites:

1. Install the GitHub CLI (gh).
2. Authenticate with GitHub by running gh auth login.

Usage: Run the script with the github:owner/repo identifier. This will generate the package configuration file locally.

$ gh auth login
$ xmake l scripts/new.lua github:glennrp/libpng

When submitting new templates to the repository, ensure they meet the following criteria:

• General-purpose: Templates must be broadly applicable.
• Lightweight: Avoid heavy dependencies or complex setups.
• Basic: Focus on fundamental project structures.

Templates that are tied to specific business logic or niche project types will be rejected.

The xmake-repo repository provides official project templates that can be used with the xmake create command to quickly bootstrap new projects.

To create a new C++ console project using a template, use the -t flag followed by the template name (e.g., console).

$ xmake create -l c++ -t console myproject

The repository provides official project templates located in the templates/ directory. You can use these templates to quickly scaffold a new project using the xmake create command.

Example for creating a C++ console application:

$ xmake create -l c++ -t console myproject