update docs

Author: waruqi

mirror/guide/configuration.html

@@ -789,7 +789,7 @@ <h2 id="environmentvariables">Environment variables</h2>
 XMAKE_RAMDIR Set the ramdisk directory.
                         <empty>
 XMAKE_GLOBALDIR Set the global config directory of xmake.
-                        /Users/ruki/.xmake
+                        /Users/ruki
 XMAKE_ROOT Allow xmake to run under root.
                         <empty>
 XMAKE_COLORTERM Set the color terminal environment.
@@ -833,8 +833,8 @@ <h3 id="xmake_globaldir">XMAKE_GLOBALDIR</h3>
 <ul>
 <li>Set the root directory of the global configuration file</li>
 </ul>
-<p>That is, the storage directory of the global configuration of <code>xmake g/global</code>, as well as other global files such as installation packages, caches, etc., will be stored in this directory by default.</p>
-<p>The default path is: <code>~/.xmake</code>.</p>
+<p>A <code>.xmake</code> directory, which serves as the storage directory of the global configuration of <code>xmake g/global</code> configuration, will be created under this path. Other global files such as installation packages, caches, etc., will be stored in this directory by default.</p>
+<p>The default path is: <code>~</code>.</p>
 <h3 id="xmake_root">XMAKE_ROOT</h3>
 <p>-Allow users to run in root mode</p>
 <p>Usually xmake is forbidden to run under root by default, which is very insecure. But if the user has to run under root, he can also set this variable to force it on.</p>
@@ -877,13 +877,13 @@ <h3 id="xmake_pkg_installdir">XMAKE_PKG_INSTALLDIR</h3>
 <ul>
 <li>Set the installation root directory of the dependent package</li>
 </ul>
-<p>The default global directory for xmake&#39;s remote package installation is <code>~/.xmake/packages</code>, but users can also set this variable to modify it individually.</p>
-<p>We can also use <code>xmake g --pkg_installdir=/xxx</code> to set it, the effect is the same.</p>
+<p>The default global directory for xmake&#39;s remote package installation is <code>$XMAKE_GLOBALDIR/.xmake/packages</code>, but users can also set this variable to modify it individually.</p>
+<p>We can also use <code>xmake g --pkg_installdir=/xxx</code> to set it, the effect is the same. However, the environment variable takes precedence over this configuration.</p>
 <h3 id="xmake_pkg_cachedir">XMAKE_PKG_CACHEDIR</h3>
 <ul>
 <li>Set the cache directory of dependent packages</li>
 </ul>
-<p>The default path is in the <code>~/.xmake/cache</code> directory, which stores various cache files during the package installation process, which takes up more storage space, and the user can also set it separately.</p>
+<p>The default path is in the <code>$XMAKE_GLOBALDIR/.xmake/cache</code> directory, which stores various cache files during the package installation process, which takes up more storage space, and the user can also set it separately.</p>
 <p>Of course, Xmake will automatically clean up all cache files of the previous month every month.</p>
 <h3 id="xmake_program_dir">XMAKE_PROGRAM_DIR</h3>
 <ul>
@@ -991,7 +991,7 @@ <h3 id="xmake_rcfiles">XMAKE_RCFILES</h3>
 <pre><code class="lang-console">$ export XMAKE_RCFILES=xmakerc.lua
 $ xmake
 </code></pre>
-<p>If not set, the default path is: <code>~/.xmake/xmakerc.lua</code>.</p>
+<p>If this environment variable is not set, users can set the global configuration file in <code>/etc/xmakerc.lua</code>, <code>~/xmakerc.lua</code>, and <code>$XMAKE_GLOBALDIR/.xmake/xmakerc.lua</code>. The search priority is listed from highest to lowest.</p>
 <h3 id="xmake_logfile">XMAKE_LOGFILE</h3>
 <ul>
 <li>Set the log file path</li>

mirror/package/local_package.html

@@ -260,6 +260,97 @@ <h4 id="specifythesearchmode">Specify the search mode</h4>
 <p>xmake will automatically append the following configuration internally when it looks for cmake packages.</p>
 <pre><code class="lang-cmake">find_package(ABC CONFIG REQUIRED)
 </code></pre>
+<h4 id="stepbysteplocalpackagingtutorial">Step by Step Local Packaging Tutorial</h4>
+<p>In this tutorial we will package a static library called foo, upload it to a GitHub repository and consume it similar to a manner of CMake FetchContent</p>
+<ul>
+<li>Create an xmake project</li>
+</ul>
+<pre><code class="lang-bash">$ xmake create -P package_origin
+</code></pre>
+<ul>
+<li>Imitate this filetree to prepare files for your package</li>
+</ul>
+<pre><code class="lang-bash">│   .gitignore
+│   xmake.lua
+└───src
+  │   main.cpp
+  ├───inc
+  │   └───foo
+  │           foo.hpp
+  └───lib
+      └───foo
+              foo.cpp
+</code></pre>
+<ul>
+<li>Create static library target in xmake</li>
+</ul>
+<pre><code class="lang-lua">target("foo")
+  set_kind("static")
+  add_files("src/lib/foo/*.cpp")
+  add_headerfiles("src/inc/foo/*.hpp")
+  add_includedirs("src/inc/foo", {public = true})
+</code></pre>
+<ul>
+<li>Implement the functionality of your target</li>
+</ul>
+<p>foo.hpp</p>
+<pre><code class="lang-cpp">void foo();
+</code></pre>
+<p>foo.cpp</p>
+<pre><code class="lang-cpp">#include <iostream>
+#include "foo.hpp"
+
+void foo() {
+    std::cout << "foo";
+}
+</code></pre>
+<ul>
+<li>Build your project and create the package</li>
+</ul>
+<pre><code class="lang-bash">$ xmake build
+$ xmake package foo
+</code></pre>
+<ul>
+<li>Move packages artifacts to a custom package repository.</li>
+</ul>
+<pre><code class="lang-bash">$ mkdir xmake_local_package_tutorial
+$ cp -r build/packages xmake_local_package_tutorial/packages
+$ cd xmake_local_package_tutorial
+$ git init
+$ git add .
+$ git commit -a -m "init"
+</code></pre>
+<p>Then push this new package repository to your custom repository, e.g. <code>https://github.com/xxx/xmake_local_package_tutorial.git</code></p>
+<ul>
+<li>Create a project where you intend on consuming the package</li>
+</ul>
+<pre><code class="lang-bash">$ xmake create package_consumption
+</code></pre>
+<ul>
+<li>Consume the package by adding the repository, finding the package and then linking the package to target of your choosing</li>
+</ul>
+<pre><code class="lang-lua">add_repositories("foo https://github.com/xxx/xmake_local_package_tutorial.git")
+add_requires("foo")
+
+target("package_consumption")
+  set_kind("binary")
+  add_files("src/*.cpp")
+  add_packages("foo")
+</code></pre>
+<p>you can also use local repository.</p>
+<pre><code class="lang-lua">add_repositories("foo /localpath/xmake_local_package_tutorial")
+</code></pre>
+<pre><code class="lang-cpp">#include "foo.hpp"
+int main() {
+    foo();
+    return 0;
+}
+</code></pre>
+<p>Congratulations, you have packaged a library and consumed it xmake!</p>
+<pre><code class="lang-bash">$ xmake build
+$ xmake run
+foo
+</code></pre>
 </article>
 </body>
 </html>

mirror/zh-cn/guide/configuration.html

@@ -797,7 +797,7 @@ <h2 id="">环境变量</h2>
 XMAKE_RAMDIR            Set the ramdisk directory.
                         <empty>
 XMAKE_GLOBALDIR         Set the global config directory of xmake.
-                        /Users/ruki/.xmake
+                        /Users/ruki
 XMAKE_ROOT              Allow xmake to run under root.
                         <empty>
 XMAKE_COLORTERM         Set the color terminal environment.
@@ -841,8 +841,8 @@ <h3 id="xmake_globaldir">XMAKE_GLOBALDIR</h3>
 <ul>
 <li>设置全局配置文件根目录</li>
 </ul>
-<p>也就是 <code>xmake g/global</code> 全局配置的存储目录，还有安装包，缓存等其他全局文件，默认都会存储在这个目录下。</p>
-<p>默认路径为：<code>~/.xmake</code>。</p>
+<p>xmake将在该目录下创建 <code>.xmake</code>，作为 <code>xmake g/global</code> 全局配置的存储目录，还有安装包，缓存等其他全局文件，默认都会存储在这个目录下。</p>
+<p>默认路径为：<code>~</code>。</p>
 <h3 id="xmake_root">XMAKE_ROOT</h3>
 <ul>
 <li>允许用户在 root 模式下运行</li>
@@ -887,13 +887,13 @@ <h3 id="xmake_pkg_installdir">XMAKE_PKG_INSTALLDIR</h3>
 <ul>
 <li>设置依赖包的安装根目录</li>
 </ul>
-<p>xmake 的远程包安装的全局目录默认是 <code>~/.xmake/packages</code>，但是用户也可以设置这个变量，去单独修改它。</p>
-<p>我们也可以使用 <code>xmake g --pkg_installdir=/xxx</code> 去设置它，效果是一样的。</p>
+<p>xmake 的远程包安装的全局目录默认是 <code>$XMAKE_GLOBALDIR/.xmake/packages</code>，但是用户也可以设置这个变量，去单独修改它。</p>
+<p>我们也可以使用 <code>xmake g --pkg_installdir=/xxx</code> 去设置它，效果是一样的。但环境变量的优先级高于此配置。</p>
 <h3 id="xmake_pkg_cachedir">XMAKE_PKG_CACHEDIR</h3>
 <ul>
 <li>设置依赖包的缓存目录</li>
 </ul>
-<p>默认路径在 <code>~/.xmake/cache</code> 目录，存储包安装过程中的各种缓存文件，比较占存储空间，用户也可以单独设置它。</p>
+<p>默认路径在 <code>$XMAKE_GLOBALDIR/.xmake/cache</code> 目录，存储包安装过程中的各种缓存文件，比较占存储空间，用户也可以单独设置它。</p>
 <p>当然，xmake 在每个月都会自动清理上个月的所有缓存文件。</p>
 <h3 id="xmake_program_dir">XMAKE_PROGRAM_DIR</h3>
 <ul>
@@ -1001,7 +1001,7 @@ <h3 id="xmake_rcfiles">XMAKE_RCFILES</h3>
 <pre><code class="lang-bash">$ export XMAKE_RCFILES=xmakerc.lua
 $ xmake
 </code></pre>
-<p>如果不设置，默认路径为：<code>~/.xmake/xmakerc.lua</code>。</p>
+<p>如果不设置此环境变量，用户可以在<code>/etc/xmakerc.lua</code>、<code>~/xmakerc.lua</code>与<code>$XMAKE_GLOBALDIR/.xmake/xmakerc.lua</code>设置全局配置文件，搜索优先级从高至低排列。</p>
 <h3 id="xmake_logfile">XMAKE_LOGFILE</h3>
 <ul>
 <li>设置日志文件路径</li>