git.sur5r.net Git - i3/i3.github.io/blob - docs/index.html.mako

   1 <%!
   2         section = "docs"
   3 %>
   4 <%inherit file="_templates/i3.mako" />
   5 <div id="content">
   6 <h2>Documentation</h2>
   7
   8 <p>
   9 One of i3’s goals is good documentation. The documents which you will find
  10 below will hopefully answer all your questions. If you have any corrections or
  11 suggestions please let us know!
  12 </p>
  13
  14 <p>
  15 These documents are for i3 version 4.1.1.
  16 </p>
  17
  18 <div class="docs">
  19 <h2>For users</h2>
  20
  21 <p style="font-size: 100%">
  22 <a href="/docs/userguide.html"><strong>User’s Guide</strong></a><br>
  23 Introduction and reference. Read this one.
  24 </p>
  25
  26 <p>
  27 <a href="/docs/multi-monitor.html"><strong>Multi-monitor</strong></a><br>
  28 Interesting for users of the nVidia driver.
  29 </p>
  30
  31 <p>
  32 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a><br>
  33 Explains you how to enable the i3 logfile.
  34 </p>
  35
  36 <p>
  37 <a href="/docs/wsbar.html"><strong>External workspace bars</strong></a><br>
  38 About bar programs such as i3bar or dzen2.
  39 </p>
  40
  41 <p>
  42 <a href="/docs/refcard.pdf"><strong>i3 reference card (PDF)</strong></a><br>
  43 Might be useful to memorize i3’s shortcuts.
  44 </p>
  45 </div>
  46
  47 <div class="docs">
  48 <h2>For developers</h2>
  49
  50 <p>
  51 <a href="/downloads/#development-version"><strong>Downloads → Development version</strong></a><br>
  52 Tells you how to check out our git repository.
  53 </p>
  54
  55 <p>
  56 <a href="/docs/hacking-howto.html"><strong>Hacking Howto</strong></a><br>
  57 Helps you if you want to get into i3’s source code.
  58 </p>
  59
  60 <p>
  61 <a href="/docs/debugging.html"><strong>Debugging i3</strong></a><br>
  62 Explains you how to enable core dumps.
  63 </p>
  64
  65 <p>
  66 <a href="/docs/ipc.html"><strong>IPC documentation</strong></a><br>
  67 Explains how i3’s Inter Process Communication interface works. Read this if you
  68 want to talk to i3 within your own scripts or programs.
  69 </p>
  70
  71 <p>
  72 <a href="/docs/testsuite.html"><strong>i3 testsuite</strong></a><br>
  73 Explains how our test suite works, including a walk-through of a whole test
  74 case.
  75 </p>
  76
  77 </div>
  78
  79 <br style="clear: both">
  80
  81 </div>