i2p/haiku-beta6
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

ReadMe: Convert to Markdown, various cleanup.

Browse Source 
* Remove references to outdated stuff (OsDrawer, old OpenGrok)
 * Removed GitHub as a code search option (not nearly as flexible
   as OpenGrok, and updated bi-monthly or so instead of daily.)
 * General reorganization.

Fixes #11842.
This commit is contained in:
Augustin Cavalier
2015-02-11 18:56:15 -05:00
parent e29c4978bb
commit 9df92fb0a2
2 changed files with 57 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ReadMe
-153
View File
@@ -1,153 +0,0 @@
Greetings.
This document is intended to serve as an introduction to the Haiku project.
As such, this is only the tip of the iceberg.
About the Haiku project
-----------------------
The Haiku project is comprised of numerous volunteers spread across the globe.
While Haiku supports localization efforts, the primary language is English.
The project is mindful of the language barrier for non-English speakers. To
note, the native language of the majority of contributors is not English.
Design goals
------------
If the ideology of the Haiku project were to be explained in a few short words,
it would be something like this. The software shall have sensible defaults with
minimal configuration required. The code shall adhere to the coding guidelines
and implement the functionality in best possible manner.
Haiku project website
---------------------
http://www.haiku-os.org
This is the main website for the Haiku project. It contains news posts from
the project, blog posts (from developers, Google Summer of Code participants,
and other frequent contributors), forums, and a vast collection of information.
Communication
-------------
http://www.haiku-os.org/community/ml
http://www.haiku-os.org/community/ml/etiquette
The primary means of communication are through mailing lists and are generally
hosted by FreeLists. In addition to the mailing lists (ML), numerous users and
contributors frequent IRC (irc.freenode.net#haiku). There is also BeShare, an
online chat and file sharing application.
* http://haikuware.com/directory/view-details/internet-network/chat-irc/beshare
* http://dev.osdrawer.net/projects/beshare
Development tracker
-------------------
http://dev.haiku-os.org/
This is the Haiku project's development tracker.
* Bug reports
* Browse the source
* Review changesets
* Development related wiki (limited write access)
{OpenGrok
---------
http://grok.bikemonkey.org/source
http://code.metager.de/source/xref/haiku
https://github.com/search?q=repo%3Ahaiku%2Fhaiku&type=Code
Graciously provided by Janne Johansson, Landon Fuller and MetaGer respectively.
This allows you to quickly and easily search Haiku's source code.
GitHub, while not {OpenGrok, also provides search functionality.
Coding Guidelines
------------------
http://www.haiku-os.org/development/coding-guidelines
The Haiku project takes pride in code quality. Both in terms of implementing
the correct code, as well as ensuring the code is written in a consistent
style. Learning and utilizing the coding guidelines is essential to
contributing code to Haiku.
Haiku API documentation
-----------------------
http://api.haiku-os.org
Old BeBook API: http://www.haiku-os.org/legacy-docs/bebook
This is the current (and in-progress) documentation for Haiku's API. As Haiku
was formed on the idea of implementing binary compatibility with BeOS R5, the
BeBook is fairly accurate. Contributions to Haiku's API book are encouraged.
Learning to Program with Haiku
------------------------------
http://www.haiku-os.org/development/learning_to_program_with_haiku
A developer, DarkWyrm has published a book that is " aimed at people who want
to be able to write simple programs to get stuff done, but never had anyone
around teach them". He has chosen to distribute the PDF versions of the book
under a Creative Commons license for noncommercial purposes.
Programming with Haiku
----------------------
http://www.haiku-os.org/tags/programmingwithhaiku
Another series from Darkwyrm. It is "aimed at current codemonkeys who want to
break into development for Haiku. Here begins a new series of programming
lessons aimed at people who already have a basic grasp on C++: Programming with
Haiku."
ohloh
-----
http://www.ohloh.net/p/haiku
"Ohloh is a free public directory of open source software and people." On
there, you can view detailed reports and analysis of Haiku (and other open
source software projects).
Haiku Interface Translation
---------------------------------
http://i18n.haiku-os.org/pootle
This is the current solution to assisting people in translating Haiku's
on screen text to other languages. Consult the [haiku-i18n] mailing list
for additional information: http://www.freelists.org/list/haiku-i18n
Haiku User Guide Translation
----------------------------
http://i18n.haiku-os.org/userguide/
Similar to the Haiku Interface Translation, this site is for coordinating the
efforts of translating Haiku's User Guide and Welcome page to other spoken
languages. Subscribe to the [haiku-doc] mailing list:
http://www.freelists.org/list/haiku-doc
HaikuPorts
----------
http://ports.haiku-files.org
http://ports-space.haiku-files.org
"HaikuPorts is a centralized collection of software ported to the Haiku
platform." If you are interested in porting software to Haiku, then this
is the site for you!
Haikuware
---------
http://www.haikuware.com
Haikuware is a website, which provides direct downloads for Haiku software.
In addition to comments on application pages there are blogs and forums.
Haikuware also holds a recurring Thank You Award and helps fund development
through bounty programs.
ReadMe.md
+57
View File
@@ -0,0 +1,57 @@
Haiku
=======================
[Homepage](https://www.haiku-os.org/)
| [Mailing Lists](https://www.haiku-os.org/community/ml)
| [IRC Channels](https://www.haiku-os.org/community/irc)
| [Issue Tracker](https://dev.haiku-os.org/)
| [API docs](https://api.haiku-os.org)
Haiku is an open-source operating system that specifically targets personal
computing. Inspired by the BeOS, Haiku is fast, simple to use, easy to learn
and yet very powerful.
Goals
------------
* Sensible defaults with minimal configuration required.
* Clean, clear, concise code.
* Unified desktop environment.
Trying Haiku
---------------
Haiku provides pre-built [nightly images](http://download.haiku-os.org/) and
[release images](https://www.haiku-os.org/get-haiku). Haiku is compatible
with a large variety of hardware, but in case you don't want to "take the
plunge" and install Haiku on bare metal, you can install it on a virtual
machine (VM) instead. If you've never used a VM before, you can follow one of
the ["Emulating Haiku"](https://www.haiku-os.org/guides/virtualizing/) guides.
Compiling Haiku
---------------
See `ReadMe.Compiling`.
Contributing
-------------------
Haiku is a meritocratic open source project with a large variety of tasks. Even
if you can't write code, *you can still help*! Haiku needs designers,
(technical) writers, translators, testers... Get involved and help out!
### Contributing code
If you're submitting a patch to us, please make sure you're following the
[patch submitting guidelines](https://dev.haiku-os.org/wiki/CodingGuidelines/SubmittingPatches).
If you're having trouble finding something in the source tree, you can use
one of our OpenGrok servers:
* http://grok.bikemonkey.org/source (provided by Landon Fuller)
* http://code.metager.de/source/xref/haiku (provided by MetaGer)
### Contributing documentation
The main piece of documentation that still needs work are the API docs (found
in the tree at `src/docs/user`). Just find an undocumented class, write
documentation for it, and [submit a patch](https://dev.haiku-os.org/wiki/CodingGuidelines/SubmittingPatches).
### Contributing translations
See [wiki:i18n](https://dev.haiku-os.org/wiki/i18n).
### Contributing software ports
See [HaikuPorts](https://bitbucket.org/haikuports/haikuports/).