1Haiku
2=======================
3**[Homepage](https://www.haiku-os.org/)
4| [Mailing Lists](https://www.haiku-os.org/community/ml)
5| [IRC Channels](https://www.haiku-os.org/community/irc)
6| [Issue Tracker](https://dev.haiku-os.org/)
7| [API docs](https://api.haiku-os.org)**
8
9Haiku is an open-source operating system that specifically targets personal
10computing. Inspired by the BeOS, Haiku is fast, simple to use, easy to learn
11and yet very powerful.
12
13Goals
14------------
15 * Sensible defaults with minimal configuration required.
16 * Clean, clear, concise code.
17 * Unified desktop environment.
18
19Trying Haiku
20---------------
21Haiku provides pre-built [nightly images](http://download.haiku-os.org/) and
22[release images](https://www.haiku-os.org/get-haiku). Haiku is compatible
23with a large variety of hardware, but in case you don't want to "take the
24plunge" and install Haiku on bare metal, you can install it on a virtual
25machine (VM) instead. If you've never used a VM before, you can follow one of
26the ["Emulating Haiku"](https://www.haiku-os.org/guides/virtualizing/) guides.
27
28Compiling Haiku
29---------------
30See `ReadMe.Compiling`.
31
32Contributing
33-------------------
34Haiku is a meritocratic open source project with a large variety of tasks. Even
35if you can't write code, *you can still help*! Haiku needs designers,
36(technical) writers, translators, testers... Get involved and help out!
37
38### Contributing code
39If you're submitting a patch to us, please make sure you're following the
40[patch submitting guidelines](https://dev.haiku-os.org/wiki/CodingGuidelines/SubmittingPatches).
41
42If you're having trouble finding something in the source tree, you can use
43one of our OpenGrok servers:
44
45 * http://xref.plausible.coop/ (provided by Landon Fuller)
46 * http://code.metager.de/source/xref/haiku (provided by MetaGer)
47
48### Contributing documentation
49The main piece of documentation that still needs work are the API docs (found
50in the tree at `docs/user`). Just find an undocumented class, write
51documentation for it, and [submit a patch](https://dev.haiku-os.org/wiki/CodingGuidelines/SubmittingPatches).
52
53### Contributing translations
54See [wiki:i18n](https://dev.haiku-os.org/wiki/i18n).
55
56### Contributing software ports
57See [HaikuPorts](https://github.com/haikuports/haikuports/).
58