瀏覽代碼

docs: Add Installation section in documentation

Ole 9 年之前
父節點
當前提交
5b7d2fa1b6
共有 5 個文件被更改,包括 27 次插入12 次删除
  1. 11 2
      docs/mkdocs/index.md
  2. 2 2
      docs/mkdocs/usage.md
  3. 11 4
      docs/output/index.html
  4. 0 1
      docs/output/mkdocs/search_index.json
  5. 3 3
      docs/output/usage/index.html

+ 11 - 2
docs/mkdocs/index.md

@@ -1,3 +1,12 @@
-# Luwra
+# Installation
 
 
-Hello World
+Luwra is a header-only library, which means that nothing has to be compiled in order to use it.
+Simply clone the [repository](https://github.com/vapourismo/luwra) or
+[download](https://github.com/vapourismo/luwra/archive/master.zip) and extract it to a directory of
+your preference.
+
+For your application to be able to reach the `lib/luwra.hpp` header file, you must add
+`/path/to/luwra/lib` to the list of include paths. With Clang and GCC that is done using the
+`-I/path/to/luwra/lib` command-line parameter.
+
+Now you can simply `#include <luwra.hpp>` in your C++ files and start using Luwra.

+ 2 - 2
docs/mkdocs/usage.md

@@ -1,3 +1,3 @@
-# Usage
+# Reference Manual
 
 
-Hello World
+A reference manual exists [here](/reference/).

+ 11 - 4
docs/output/index.html

@@ -60,7 +60,7 @@
         
         
             <ul>
             <ul>
             
             
-                <li class="toctree-l3"><a href="#luwra">Luwra</a></li>
+                <li class="toctree-l3"><a href="#installation">Installation</a></li>
                 
                 
             
             
             </ul>
             </ul>
@@ -111,8 +111,15 @@
           <div role="main">
           <div role="main">
             <div class="section">
             <div class="section">
               
               
-                <h1 id="luwra">Luwra</h1>
-<p>Hello World</p>
+                <h1 id="installation">Installation</h1>
+<p>Luwra is a header-only library, which means that nothing has to be compiled in order to use it.
+Simply clone the <a href="https://github.com/vapourismo/luwra">repository</a> or
+<a href="https://github.com/vapourismo/luwra/archive/master.zip">download</a> and extract it to a directory of
+your preference.</p>
+<p>For your application to be able to reach the <code>lib/luwra.hpp</code> header file, you must add
+<code>/path/to/luwra/lib</code> to the list of include paths. With Clang and GCC that is done using the
+<code>-I/path/to/luwra/lib</code> command-line parameter.</p>
+<p>Now you can simply <code>#include &lt;luwra.hpp&gt;</code> in your C++ files and start using Luwra.</p>
               
               
             </div>
             </div>
           </div>
           </div>
@@ -160,5 +167,5 @@
 
 
 <!--
 <!--
 MkDocs version : 0.15.3
 MkDocs version : 0.15.3
-Build Date UTC : 2016-03-30 15:40:50.085547
+Build Date UTC : 2016-03-30 16:00:58.248155
 -->
 -->

文件差異過大導致無法顯示
+ 0 - 1
docs/output/mkdocs/search_index.json


+ 3 - 3
docs/output/usage/index.html

@@ -67,7 +67,7 @@
         
         
             <ul>
             <ul>
             
             
-                <li class="toctree-l3"><a href="#usage">Usage</a></li>
+                <li class="toctree-l3"><a href="#reference-manual">Reference Manual</a></li>
                 
                 
             
             
             </ul>
             </ul>
@@ -111,8 +111,8 @@
           <div role="main">
           <div role="main">
             <div class="section">
             <div class="section">
               
               
-                <h1 id="usage">Usage</h1>
-<p>Hello World</p>
+                <h1 id="reference-manual">Reference Manual</h1>
+<p>A reference manual exists <a href="../reference/">here</a>.</p>
               
               
             </div>
             </div>
           </div>
           </div>

部分文件因文件數量過多而無法顯示