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