xref: /haiku/ReadMe.md (revision a8438bc2009c346c72b9aca080bad70edc352ada)
19df92fb0SAugustin CavalierHaiku
29df92fb0SAugustin Cavalier=======================
3fd2c0fa4SAugustin Cavalier**[Homepage](https://www.haiku-os.org/)
49df92fb0SAugustin Cavalier| [Mailing Lists](https://www.haiku-os.org/community/ml)
59df92fb0SAugustin Cavalier| [IRC Channels](https://www.haiku-os.org/community/irc)
69df92fb0SAugustin Cavalier| [Issue Tracker](https://dev.haiku-os.org/)
7fd2c0fa4SAugustin Cavalier| [API docs](https://api.haiku-os.org)**
89df92fb0SAugustin Cavalier
99df92fb0SAugustin CavalierHaiku is an open-source operating system that specifically targets personal
109df92fb0SAugustin Cavaliercomputing. Inspired by the BeOS, Haiku is fast, simple to use, easy to learn
119df92fb0SAugustin Cavalierand yet very powerful.
129df92fb0SAugustin Cavalier
139df92fb0SAugustin CavalierGoals
149df92fb0SAugustin Cavalier------------
159df92fb0SAugustin Cavalier * Sensible defaults with minimal configuration required.
169df92fb0SAugustin Cavalier * Clean, clear, concise code.
179df92fb0SAugustin Cavalier * Unified desktop environment.
189df92fb0SAugustin Cavalier
199df92fb0SAugustin CavalierTrying Haiku
209df92fb0SAugustin Cavalier---------------
219df92fb0SAugustin CavalierHaiku provides pre-built [nightly images](http://download.haiku-os.org/) and
229df92fb0SAugustin Cavalier[release images](https://www.haiku-os.org/get-haiku). Haiku is compatible
239df92fb0SAugustin Cavalierwith a large variety of hardware, but in case you don't want to "take the
249df92fb0SAugustin Cavalierplunge" and install Haiku on bare metal, you can install it on a virtual
259df92fb0SAugustin Cavaliermachine (VM) instead. If you've never used a VM before, you can follow one of
269df92fb0SAugustin Cavalierthe ["Emulating Haiku"](https://www.haiku-os.org/guides/virtualizing/) guides.
279df92fb0SAugustin Cavalier
289df92fb0SAugustin CavalierCompiling Haiku
299df92fb0SAugustin Cavalier---------------
309df92fb0SAugustin CavalierSee `ReadMe.Compiling`.
319df92fb0SAugustin Cavalier
329df92fb0SAugustin CavalierContributing
339df92fb0SAugustin Cavalier-------------------
349df92fb0SAugustin CavalierHaiku is a meritocratic open source project with a large variety of tasks. Even
359df92fb0SAugustin Cavalierif you can't write code, *you can still help*! Haiku needs designers,
369df92fb0SAugustin Cavalier(technical) writers, translators, testers... Get involved and help out!
379df92fb0SAugustin Cavalier
389df92fb0SAugustin Cavalier### Contributing code
399df92fb0SAugustin CavalierIf you're submitting a patch to us, please make sure you're following the
409df92fb0SAugustin Cavalier[patch submitting guidelines](https://dev.haiku-os.org/wiki/CodingGuidelines/SubmittingPatches).
419df92fb0SAugustin Cavalier
429df92fb0SAugustin CavalierIf you're having trouble finding something in the source tree, you can use
439df92fb0SAugustin Cavalierone of our OpenGrok servers:
449df92fb0SAugustin Cavalier
45fd2c0fa4SAugustin Cavalier * http://xref.plausible.coop/ (provided by Landon Fuller)
469df92fb0SAugustin Cavalier * http://code.metager.de/source/xref/haiku (provided by MetaGer)
479df92fb0SAugustin Cavalier
489df92fb0SAugustin Cavalier### Contributing documentation
499df92fb0SAugustin CavalierThe main piece of documentation that still needs work are the API docs (found
50fe4a91e3SAugustin Cavalierin the tree at `docs/user`). Just find an undocumented class, write
519df92fb0SAugustin Cavalierdocumentation for it, and [submit a patch](https://dev.haiku-os.org/wiki/CodingGuidelines/SubmittingPatches).
529df92fb0SAugustin Cavalier
539df92fb0SAugustin Cavalier### Contributing translations
549df92fb0SAugustin CavalierSee [wiki:i18n](https://dev.haiku-os.org/wiki/i18n).
559df92fb0SAugustin Cavalier
569df92fb0SAugustin Cavalier### Contributing software ports
57*a8438bc2SAugustin CavalierSee [HaikuPorts](https://github.com/haikuports/haikuports/).
58