Skip to content
This repository has been archived by the owner on Apr 18, 2023. It is now read-only.

Commit

Permalink
hacking-howto: Add warning
Browse files Browse the repository at this point in the history
  • Loading branch information
orestisfl committed May 6, 2020
1 parent cdf5ccb commit 4b97027
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -38,4 +38,4 @@ Note that bug reports and feature requests for related projects should be filed
* Find a [reproducible bug](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Areproducible+label%3Abug+) from the issue tracker. These issues have been reviewed and confirmed by a project contributor.
* Find an [accepted enhancement](https://github.com/i3/i3/issues?utf8=%E2%9C%93&q=is%3Aopen+label%3Aaccepted+label%3Aenhancement) from the issue tracker. These have been approved and are ok to start working on.

There's a very good [overview of the codebase](https://i3wm.org/docs/hacking-howto.html) available to get you started.
There's an [overview of the codebase](https://i3wm.org/docs/hacking-howto.html) available to get you started.
14 changes: 14 additions & 0 deletions docs/hacking-howto
Expand Up @@ -8,6 +8,19 @@ touching i3’s source code. It should contain all important information to help
you understand why things are like they are. If it does not mention something
you find necessary, please do not hesitate to contact me.

++++
<div style="background-color:red; color:white; padding:20px;">
<strong style="color:white;">WARNING!</strong>
<p>
++++
This document is not 100% up to date. Specifically, everything up to and
including <<data_structures>> has been updated recently. The rest might contain
outdated information.
++++
</p>
</div>
++++

== Building i3

You can build i3 like you build any other software package which uses autotools.
Expand Down Expand Up @@ -246,6 +259,7 @@ A file containing all X11 atoms which i3 uses. This file will be included
various times (for defining, requesting and receiving the atoms), each time
with a different definition of xmacro().

[[data_structures]]
== Data structures

See +include/data.h+ for documented data structures. The most important ones are
Expand Down

0 comments on commit 4b97027

Please sign in to comment.