taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Add 'Quick Start' to the Overview page

Browse Source
This commit is contained in:
Chris Cummer
2018-05-23 11:10:54 -07:00
parent f23ac8573f
commit faf4bce756
11 changed files with 118 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/posts/overview/index.html
View File

@@ -113,14 +113,18 @@
keep browser tabs open for, the kinds of things you don’t always need
visible, but might check in on every now and then.</p>
<p><a href="https://github.com/senorprogrammer/wtf/releases">Download it</a> as a stand-alone, compiled binary, or install it <a href="https://github.com/senorprogrammer/wtf">from source</a>.</p>
<h2 id="quick-start">Quick Start</h2>
<p>Once installed, edit your <a
href="/posts/configuration/">configuration file</a> and define the
modules you want to run.</p>
<ol>
<li><a href="https://github.com/senorprogrammer/wtf/releases">Download</a> the stand-alone, compiled binary.</li>
<li>Unzip the downloaded file.</li>
<li>From the command line, <code>cd</code> into the newly-created <code>/wtf</code> directory.</li>
<li>From the command line, run the app: <code>./wtf</code></li>
</ol>
<p>Configuration instructions for each module can be found in the module
pages, listed at left.</p>
<p>This should launch the app in your terminal using the default simple
configuration. See <a href="/posts/configuration/">Configuration</a> for
more details.</p>
<h2 id="command-line-options">Command-line Options</h2>