1Greetings.
2
3This document is intended to serve as an introduction to the Haiku project.
4As such, this is only the tip of the iceberg.
5
6
7About the Haiku project
8-----------------------
9The Haiku project is comprised of numerous volunteers spread across the globe.
10While Haiku supports localization efforts, the primary language is English.
11The project is mindful of the language barrier for non-English speakers. To
12note, the native language of the majority of contributors is not English.
13
14
15Design goals
16------------
17If the ideology of the Haiku project were to be explained in a few short words,
18it would be something like this. The software shall have sensible defaults with
19minimal configuration required. The code shall adhere to the coding guidelines
20and implement the functionality in best possible manner.
21
22
23Haiku project website
24---------------------
25http://www.haiku-os.org
26
27This is the main website for the Haiku project. It contains news posts from
28the project, blog posts (from developers, Google Summer of Code participants,
29and other frequent contributors), forums, and a vast collection of information.
30
31
32Communication
33-------------
34http://www.haiku-os.org/community/ml
35http://www.haiku-os.org/community/ml/etiquette
36
37The primary means of communication are through mailing lists and are generally
38hosted by FreeLists. In addition to the mailing lists (ML), numerous users and
39contributors frequent IRC (irc.freenode.net#haiku). There is also BeShare, an
40online chat and file sharing application.
41 * http://haikuware.com/directory/view-details/internet-network/chat-irc/beshare
42 * http://dev.osdrawer.net/projects/beshare
43
44
45Development tracker
46-------------------
47http://dev.haiku-os.org/
48
49This is the Haiku project's development tracker.
50 * Bug reports
51 * Browse the source
52 * Review changesets
53 * Development related wiki (limited write access)
54
55
56{OpenGrok
57---------
58http://haiku.it.su.se:8180/source
59http://grok.bikemonkey.org/source
60http://code.metager.de/source/xref/haiku
61
62Graciously provided by Janne Johansson, Landon Fuller and MetaGer respectively.
63This allows you to quickly and easily search Haiku's source code.
64
65
66Coding Guidelines
67------------------
68http://www.haiku-os.org/development/coding-guidelines
69
70The Haiku project takes pride in code quality. Both in terms of implementing
71the correct code, as well as ensuring the code is written in a consistent
72style. Learning and utilizing the coding guidelines is essential to
73contributing code to Haiku.
74
75
76Haiku API documentation
77-----------------------
78http://api.haiku-os.org
79Old BeBook API: http://www.haiku-os.org/legacy-docs/bebook
80
81This is the current (and in-progress) documentation for Haiku's API. As Haiku
82was formed on the idea of implementing binary compatibility with BeOS R5, the
83BeBook is fairly accurate. Contributions to Haiku's API book are encouraged.
84
85
86Learning to Program with Haiku
87------------------------------
88http://www.haiku-os.org/development/learning_to_program_with_haiku
89
90A developer, DarkWyrm has published a book that is " aimed at people who want
91to be able to write simple programs to get stuff done, but never had anyone
92around teach them". He has chosen to distribute the PDF versions of the book
93under a Creative Commons license for noncommercial purposes.
94
95
96Programming with Haiku
97----------------------
98http://www.haiku-os.org/tags/programmingwithhaiku
99
100Another series from Darkwyrm. It is "aimed at current codemonkeys who want to
101break into development for Haiku. Here begins a new series of programming
102lessons aimed at people who already have a basic grasp on C++: Programming with
103Haiku."
104
105
106ohloh
107-----
108http://www.ohloh.net/p/haiku
109
110"Ohloh is a free public directory of open source software and people." On
111there, you can view detailed reports and analysis of Haiku (and other open
112source software projects).
113
114
115Haiku Interface Translation
116---------------------------------
117http://i18n.haiku-os.org/pootle
118
119This is the current solution to assisting people in translating Haiku's
120on screen text to other languages. Consult the [haiku-i18n] mailing list
121for additional information: http://www.freelists.org/list/haiku-i18n
122
123
124Haiku User Guide Translation
125----------------------------
126http://i18n.haiku-os.org/userguide/
127
128Similar to the Haiku Interface Translation, this site is for coordinating the
129efforts of translating Haiku's User Guide and Welcome page to other spoken
130languages. Subscribe to the [haiku-doc] mailing list:
131http://www.freelists.org/list/haiku-doc
132
133
134HaikuPorts
135----------
136http://ports.haiku-files.org
137http://ports-space.haiku-files.org
138
139"HaikuPorts is a centralized collection of software ported to the Haiku
140platform." If you are interested in porting software to Haiku, then this
141is the site for you!
142
143
144Haikuware
145---------
146http://www.haikuware.com
147
148Haikuware is a website, which provides direct downloads for Haiku software.
149In addition to comments on application pages there are blogs and forums.
150Haikuware also holds a recurring Thank You Award and helps fund development
151through bounty programs.
152
153