TBOOX Open Source Project

• Api Manual

  2000-02-22

  xmake

  xmake  docs  manual
  • Specification
    • Naming conventions

  Note: This documents is only a mirror, if you want to see newest documents please goto: http://xmake.io/#/manual

  Specification

  Naming conventions

  The interface is named according to some of the predefined specifications, which is more convenient to understand and easy to use.

  It’s according to the following rules:

  Interfaces	Description
  is_ + xxx	Condition interfaces
  set_ + xxx	Set and override the previous settings
  add_ + xxx	Set and append settings
  s + xxx	Support multi-parameters, .e.g：add_files("*.c", "test.cpp")
  on_ + xxx	Set and override builtin script
  before_ + xxx	Set and run this script before running builtin-script
  after_ + xxx	Set and run this script after running builtin-script
  scope("name")	Define a description scope, .e.g target("xxx"), option("xxx")
  scope/settings	Indentation with spaces

  阅读中文 Read All

  ---

• Quick Start

  2000-02-22

  xmake

  xmake  docs  quickstart
  • Introduction
  • Installation
    • Master
      • via curl
      • via wget
      • via powershell
    • Windows
    • MacOS
    • Linux

  Note: This documents is only a mirror, if you want to see newest documents please goto: http://xmake.io/#/home/

  

  xmake

  

  

  A cross-platform build utility based on Lua

  Introduction

  xmake is a cross-platform build utility based on lua.

  The project focuses on making development and building easier and provides many features (.e.g package, install, plugin, macro, action, option, task …), so that any developer can quickly pick it up and enjoy the productivity boost when developing and building project.

  Installation

  Master

  via curl

  bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
  

  via wget

  bash <(wget https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh -O -)
  

  via powershell

  Invoke-Expression (Invoke-Webrequest 'https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.ps1' -UseBasicParsing).Content
  

  Windows

  1. Download xmake windows installer from Releases
  2. Run xmake-[version].exe

  MacOS

  $ brew install xmake
  

  Linux

  On Archlinux:

  $ yaourt xmake
  

  阅读中文 Read All

  ---