README.md

   1 # An algorithm library {#mainpage}
   2
   3 [![docs](https://github.com/tqfx/liba/actions/workflows/docs.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/docs.yml)
   4 [![conan](https://github.com/tqfx/liba/actions/workflows/conan.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/conan.yml)
   5 [![xmake](https://github.com/tqfx/liba/actions/workflows/xmake.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/xmake.yml)
   6 [![meson](https://github.com/tqfx/liba/actions/workflows/meson.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/meson.yml)
   7 [![msvc](https://github.com/tqfx/liba/actions/workflows/msvc.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/msvc.yml)
   8 [![linux](https://github.com/tqfx/liba/actions/workflows/linux.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/linux.yml)
   9 [![macos](https://github.com/tqfx/liba/actions/workflows/macos.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/macos.yml)
  10 [![mingw](https://github.com/tqfx/liba/actions/workflows/mingw.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/mingw.yml)
  11 [![msys2](https://github.com/tqfx/liba/actions/workflows/msys2.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/msys2.yml)
  12 [![freebsd](https://github.com/tqfx/liba/actions/workflows/freebsd.yml/badge.svg)](https://github.com/tqfx/liba/actions/workflows/freebsd.yml)
  13
  14 ## documentation
  15
  16 - [C/C++](https://tqfx.org/liba/)
  17 - [Lua](https://tqfx.org/liba/lua/)
  18 - [Java](https://tqfx.org/liba/java/)
  19 - [Rust](https://tqfx.org/liba/rust/liba/)
  20
  21 ## required tools
  22
  23 - C/C++ compiler: [tcc](https://bellard.org/tcc) or [gnu](https://gcc.gnu.org) or [llvm](https://clang.llvm.org) or [msvc](https://visualstudio.microsoft.com/visual-cpp-build-tools) etc
  24
  25 ## optional tools
  26
  27 - [lua](https://www.lua.org)
  28 - [java](https://www.oracle.com/java)
  29 - [rust](https://www.rust-lang.org)
  30 - [emsdk](https://emscripten.org)
  31 - [xmake](https://xmake.io)
  32 - [cmake](https://cmake.org)
  33 - [conan](https://conan.io)
  34 - [vcpkg](https://vcpkg.io)
  35 - [meson](https://mesonbuild.com)
  36 - [python](https://www.python.org)
  37 - [quickjs](https://github.com/bellard/quickjs)
  38
  39 ## build
  40
  41 ### xmake
  42
  43 ```bash
  44 xmake f
  45 xmake
  46 xmake i
  47 ```
  48
  49 ### cmake
  50
  51 ```bash
  52 cmake -S . -B build
  53 cmake --build build
  54 cmake --install build
  55 ```
  56
  57 ### meson
  58
  59 ```bash
  60 meson setup builddir
  61 meson install -C builddir
  62 ```
  63
  64 ### vcpkg
  65
  66 ```bash
  67 cmake -S . -B build -DLIBA_VCPKG=1
  68 ```
  69
  70 ```bash
  71 cp -r build/vcpkg/* $VCPKG_INSTALLATION_ROOT
  72 ```
  73
  74 ```pwsh
  75 cp -r -Force build/vcpkg/* $ENV:VCPKG_INSTALLATION_ROOT
  76 ```
  77
  78 ### conan
  79
  80 ```bash
  81 conan create .
  82 ```
  83
  84 ### cargo
  85
  86 ```bash
  87 cargo build --release
  88 ```
  89
  90 ### cython
  91
  92 ```bash
  93 python setup.py build_ext --inplace
  94 ```
  95
  96 ## usage
  97
  98 ### C/C++
  99
 100 #### xmake.lua
 101
 102 ```lua
 103 add_requires("a")
 104 ```
 105
 106 ### CMakeLists.txt
 107
 108 ```cmake
 109 find_package(liba CONFIG REQUIRED)
 110 target_link_libraries(<TARGET> PRIVATE alib) # static
 111 target_link_libraries(<TARGET> PRIVATE liba) # shared
 112 ```
 113
 114 #### conanfile.txt
 115
 116 ```txt
 117 [requires]
 118 liba/[~0.1]
 119 ```
 120
 121 ### Lua
 122
 123 ```bash
 124 luarocks install liba # release
 125 ```
 126
 127 ```bash
 128 luarocks install --server=https://luarocks.org/dev liba # latest
 129 ```
 130
 131 ```lua
 132 local liba = require("liba")
 133 print("version", liba.VERSION)
 134 ```
 135
 136 ### Java
 137
 138 ```java
 139 public class Main {
 140     public static void main(String[] args) {
 141         System.out.println("version " + liba.VERSION);
 142     }
 143 }
 144 ```
 145
 146 ### Rust
 147
 148 #### Cargo.toml
 149
 150 ```toml
 151 [dependencies]
 152 liba = { git = "https://github.com/tqfx/liba.git" }
 153 ```
 154
 155 #### main.rs
 156
 157 ```rs
 158 use liba;
 159 fn main() {
 160     println!("version {}", liba::version());
 161 }
 162 ```
 163
 164 ### Python
 165
 166 ```bash
 167 pip install liba # release
 168 ```
 169
 170 ```bash
 171 pip install git+https://github.com/tqfx/liba.git # latest
 172 ```
 173
 174 #### main.py
 175
 176 ```py
 177 import liba
 178 print("version", liba.VERSION)
 179 ```
 180
 181 ### JavaScript
 182
 183 ```bash
 184 npm i @tqfx/liba
 185 ```
 186
 187 #### index.js
 188
 189 ```js
 190 import liba from "@tqfx/liba";
 191 console.log(liba.VERSION)
 192 ```
 193
 194 ### QuickJS
 195
 196 #### main.js
 197
 198 ```js
 199 import * as liba from "liba.so";
 200 console.log("version", liba.VERSION)
 201 ```
 202
 203 ## Copyright {#copyright}
 204
 205 Copyright (C) 2020-present tqfx, All rights reserved.
 206
 207 This Source Code Form is subject to the terms of the Mozilla Public
 208 License, v. 2.0. If a copy of the MPL was not distributed with this
 209 file, You can obtain one at <https://mozilla.org/MPL/2.0/>.