aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorValentin Popov <info@valentineus.link>2017-12-15 08:55:13 +0300
committerValentin Popov <info@valentineus.link>2017-12-15 08:55:13 +0300
commitc005d271c2b83208a130dc2b5e99efd21ef47e5c (patch)
tree99f61a6b207fd6382e3d366993f4e6755372da2a /docs
parentaa0f07c285a530de6455d8b1a4c27af522018386 (diff)
downloadauth_token-c005d271c2b83208a130dc2b5e99efd21ef47e5c.tar.xz
auth_token-c005d271c2b83208a130dc2b5e99efd21ef47e5c.zip
User manual template
Diffstat (limited to 'docs')
-rw-r--r--docs/getting-started.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md
new file mode 100644
index 0000000..b3985a0
--- /dev/null
+++ b/docs/getting-started.md
@@ -0,0 +1,31 @@
+# Getting Started
+
+## Navigation
+
+* [Installation]()
+ * [Build]()
+* [User's Manual]()
+
+## Installation
+
+Get the installation package in any of the available methods:
+
+* [GitHub Releases](https://github.com/valentineus/moodle-auth_token/releases).
+* [Compilation from the source code](#build).
+
+### Build
+
+Self-assembly package is as follows:
+
+* Clone the repository:
+```bash
+git clone https://github.com/valentineus/moodle-auth_token.git moodle-auth_token
+```
+
+* Run the build script:
+```bash
+cd ./moodle-auth_token
+/bin/sh build.sh
+```
+
+## User's Manual