From 7aa2cb2e64cd404f8a9f388d85ab287ced95f139 Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Tue, 16 Feb 2010 01:24:37 +0000 Subject: OTP-8449 Documentation improvements. The most important "readme" files now use Markdown notation. HTML versions of these files are now also automatically generated and included in the HTML documentation. - Building and Installing Erlang/OTP - $ERL_TOP/INSTALL.md (previously known as $ERL_TOP/README). - Cross Compiling Erlang/OTP - $ERL_TOP/INSTALL-CROSS.md. - How to Build Erlang/OTP on Windows - $ERL_TOP/INSTALL-WIN32.md (previously known as $ERL_TOP/README.win32). --- README.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 76 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 0000000000..c38f097b0f --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +Erlang/OTP +========== + +**Erlang** is a programming language used to build massively scalable soft +real-time systems with requirements on high availability. Some of its +uses are in telecom, banking, e-commerce, computer telephony and +instant messaging. Erlang's runtime system has built-in support for +concurrency, distribution and fault tolerance. + +**OTP** is set of Erlang libraries and design principles providing +middle-ware to develop these systems. It includes its own distributed +database, applications to interface towards other languages, debugging +and release handling tools. + +More information can be found at [erlang.org] [1]. + +Building and Installing +----------------------- + +Information on building and installing Erlang/OTP can be found +in the `INSTALL.md` document. + +Contributing to Erlang/OTP +-------------------------- + +Here are the [instructions for submitting patches] [2]. + +In short: + +* We prefer to receive proposed updates via email on the + [`erlang-patches`] [3] mailing list rather than through a pull request. + Pull requests are not practical because we have a strict policy never to + merge any untested changes to the development branch (the only exception + being **obviously** correct changes, such as corrections of typos). + +* We merge all proposed updates to the `pu` (*proposed updates*) branch, + typically within one working day. + +* At least once a day, the contents of the `pu` branch will be built on + several platforms (Linux, Solaris, Mac OS X, Windows, and so on) and + automatic test suites will be run. We will email you if any problems are + found. + +* If a proposed change builds and passes the tests, it will be reviewed + by one or more members of the Erlang/OTP team at Ericsson. The reviewer + may suggest improvements that are needed before the change can be accepted + and merged. + +* Once or twice a week, a status email called "What's cooking in Erlang/OTP" + will be sent to the [`erlang-patches`] [3] mailing list. + +Copyright and License +--------------------- + +> %CopyrightBegin% +> +> Copyright Ericsson AB 2010. All Rights Reserved. +> +> The contents of this file are subject to the Erlang Public License, +> Version 1.1, (the "License"); you may not use this file except in +> compliance with the License. You should have received a copy of the +> Erlang Public License along with this software. If not, it can be +> retrieved online at http://www.erlang.org/. +> +> Software distributed under the License is distributed on an "AS IS" +> basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See +> the License for the specific language governing rights and limitations +> under the License. +> +> %CopyrightEnd% + + + + [1]: http://www.erlang.org + [2]: http://wiki.github.com/erlang/otp/submitting-patches + [3]: http://www.erlang.org/faq.html -- cgit v1.2.3