]> git.sur5r.net Git - i3/i3.github.io/blob - index.html.mako
3c124d2627898a4556ca95a69ce36804428ae375
[i3/i3.github.io] / index.html.mako
1 <%!
2         section = "index"
3 %>
4 <%inherit file="_templates/i3.mako" />
5 <div id="info" class="clearfix">
6
7     <div id="screens">
8         <img id="screenshot" src="/screenshots/i3-6.png" width="375" height="219">
9     </div>
10
11     <h2>Do What I Mean. Good Docs. Clean Code. Sounds good?</h2>
12     <p>Bleh bleh.</p>
13     <div id="download">
14         <a href="/downloads">
15         <span style="font-weight: bold; color: #3A8ECD; margin-right: .5em">➡</span>
16         Download the latest version
17         <span style="margin-left: 2em; color: #c0c0c0">3.ε</span>
18         </a>
19     </div>
20 </div>
21
22 <div id="content">
23 <p>
24 i3 is a tiling window manager, completely written from scratch. It is primarily
25 targeted at advanced users and developers. Based upon the experiences we made
26 when wanting to hack/fix wmii, we agreed upon the following goals for i3:
27 </p> 
28  
29 <ol> 
30   <li> 
31     Write well readable, well <strong>documented</strong> code. Create additional
32     documentation on how to extend i3 by explaining its internal workings.
33     <br /> 
34     This includes being modifiable by people who do know how to program but who are
35     not necessarily familiar with all of X11’s internals. That is, document why
36     things happen and when they happen so that the user gets a picture of the whole
37     process a Window Manager is responsible of by just reading the source code.
38   </li> 
39   <li> 
40     Use xcb as far as possible (it does not provide functions for some features
41     yet, like XKB) instead of Xlib. xcb has a much cleaner API and should be faster
42     in quite a lot of situations.
43   </li> 
44   <li> 
45     Implement multi-monitor correctly, that is by assigning each workspace to a
46     virtual screen. Especially make sure that attaching and detaching new monitors
47     like video projectors works during operation and does the right thing. Also
48     provide support for rotated monitors.
49   </li> 
50   <li> 
51     Use a tree as data structure. This allows for more flexible layouts than
52     the column-based approach used by other window managers.
53   </li> 
54   <li> 
55     Implement different modes, like in vim. You can use different keybindings
56     when in the 'resize' mode than when you are in the default mode, for
57     example.
58   </li> 
59   <li> 
60     Do <strong>not</strong> use programs such as autoconf/automake for configuration and
61     creating unreadable/broken makefiles. Instead, use a clean makefile which automatically
62     enables/disables features for specific platforms. Also, document the dependencies
63     properly, so that package maintainers have an easy job packaging i3.
64   </li> 
65   <li> 
66     Implement an IPC interface for other programs. Provide subscription to
67     certain events and accept commands.
68     <br /> 
69     This approach should be more lightweight than wmii’s usage of the 9P filesystem.
70     Furthermore, core functionality does not depend on a separate program, so that i3
71     runs faster, especially when your system is under load.
72   </li> 
73   <li> 
74     Be UTF-8 clean.
75   </li> 
76   <li> 
77     The usual elitism amongst minimal window managers: Don’t be bloated, don’t be fancy
78     (simple borders are the most decoration we want to have), don’t add support for Xft
79     and blurred fonts.
80     <br /> 
81     However, we do not enforce unnecessary limits such as a maximum amount of source lines
82     of code. If it needs to be a bit bigger, it will be.
83   </li> 
84 </ol> 
85  
86 </div>