Skip to content

Commit 2262cd3

Browse files
committed
doc: add install document
1 parent 5e4bd0c commit 2262cd3

File tree

2 files changed

+52
-4
lines changed

2 files changed

+52
-4
lines changed

README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,11 @@ The user-friendly API is implemented top of low-level libxml2 API.
2020

2121
## Install
2222

23-
```console
24-
% luarocks install xmlua
25-
```
23+
See [online document](https://clear-code.github.io/xmlua/install/).
2624

2725
## Usage
2826

29-
See [online document](https://clear-code.github.io/xmlua/).
27+
See [online document](https://clear-code.github.io/xmlua/tutorial/).
3028

3129
## Authors
3230

docs/install/index.md

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
title: Install
3+
---
4+
5+
# Install
6+
7+
This document how to install XMLua on the following platforms:
8+
9+
* [Debian GNU/Linux](#debian)
10+
11+
* [Ubuntu](#ubuntu)
12+
13+
* [CentOS](#centos)
14+
15+
* [macOS](#macos)
16+
17+
You must install [LuaJIT][luajit] and [LuaRocks][luarocks] before installing XMLua.
18+
19+
## Debian GNU/Linux {#debian}
20+
21+
```console
22+
% sudo apt install -y -V libxml2
23+
% sudo luarocks install xmlua
24+
```
25+
26+
## Ubuntu {#ubuntu}
27+
28+
```console
29+
% sudo apt install -y -V libxml2
30+
% sudo luarocks install xmlua
31+
```
32+
33+
## CentOS {#centos}
34+
35+
```console
36+
% sudo yum install -y libxml2
37+
% sudo luarocks install xmlua
38+
```
39+
40+
## macOS {#macos}
41+
42+
```console
43+
% brew install libxml2
44+
% sudo luarocks install xmlua
45+
```
46+
47+
48+
[luajit]:http://luajit.org/
49+
50+
[luarocks]:https://luarocks.org/

0 commit comments

Comments
 (0)