TBOOX开源工程

• 接口手册

  2000-02-22

  xmake

  xmake  文档  手册
  • 接口规范
    • 命名规范

  注：此处为镜像文档，最新在线文档请看：http://xmake.io/#/zh/manual

  接口规范

  命名规范

  接口的命名，是有按照预定义的一些规范来命名的，这样更加方便理解和易于使用，目前命名按照如下一些规则：

  接口规则	描述
  is_前缀的接口	表示为条件判断
  set_前缀的接口	表示为覆盖设置
  add_前缀的接口	表示为追加设置
  s后缀的接口	表示支持多值传入，例如：add_files("*.c", "test.cpp")
  on_前缀的接口	表示为覆盖内置脚本
  before_前缀的接口	表示为在内置脚本运行前，执行此脚本
  after_前缀的接口	表示为在内置脚本运行后，执行此脚本
  scope("name")的接口	表示为定义一个描述域，例如：target("xxx"), option("xxx")
  描述域/描述设置	建议缩进表示

  Read English 阅读全文

  ---

• 快速开始

  2000-02-22

  xmake

  xmake  文档  快速开始
  • 简介
  • 安装
    • Master版本
      • 使用curl
      • 使用wget
      • 使用powershell
    • Windows
    • MacOS
    • Linux

  注：此处为镜像文档，最新在线文档请看：http://xmake.io/#/zh/

  

  xmake

  

  

  一个基于Lua的轻量级跨平台自动构建工具

  简介

  XMake是一个基于Lua的轻量级跨平台自动构建工具，支持在各种主流平台上构建项目

  xmake的目标是开发者更加关注于项目本身开发，简化项目的描述和构建，并且提供平台无关性，使得一次编写，随处构建

  它跟cmake、automake、premake有点类似，但是机制不同，它默认不会去生成IDE相关的工程文件，采用直接编译，并且更加的方便易用 采用lua的工程描述语法更简洁直观，支持在大部分常用平台上进行构建，以及交叉编译

  并且xmake提供了创建、配置、编译、打包、安装、卸载、运行等一些actions，使得开发和构建更加的方便和流程化。

  不仅如此，它还提供了许多更加高级的特性，例如插件扩展、脚本宏记录、批量打包、自动文档生成等等。。

  安装

  Master版本

  使用curl

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

  使用wget

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

  使用powershell

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

  Windows

  1. 从 Releases 上下载windows安装包
  2. 运行安装程序 xmake-[version].exe

  MacOS

  $ ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
  $ brew install xmake
  

  或者：

  1. 从 Releases 上下载pkg安装包
  2. 双击运行

  或者安装master版本:

  # 使用homebrew安装master版本
  $ brew install xmake --HEAD
  
  # 或者直接调用shell下载安装
  $ bash <(curl -fsSL https://raw.githubusercontent.com/tboox/xmake/master/scripts/get.sh)
  

  Linux

  在archlinux上安装：

  $ yaourt xmake
  

  Read English 阅读全文

  ---