aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHaneef Mubarak <haneefmubarak@users.noreply.github.com>2014-02-22 19:06:44 -0800
committerHaneef Mubarak <haneefmubarak@users.noreply.github.com>2014-02-22 19:07:35 -0800
commit6233cc5e8bce542cfaa6d930c15215f14cfe2bc1 (patch)
tree75707e3f6ae3edee0cb9d43b85515c9675a1796e
parentd250abb7cb41043dc3f8cbf3cc4de3be2bdf614a (diff)
rewrote READMEs and other markdown docs
**all: folded to margins** README: used local image, expanded license into a small section CONTRIBUTING: added title relooper README: removed licensing data (root of repo contains license)
-rw-r--r--CONTRIBUTING.md3
-rw-r--r--README.md26
-rw-r--r--src/relooper/README.md18
3 files changed, 29 insertions, 18 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ceea8735..c068eb7f 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,5 +1,6 @@
+Contributing
+============
See our wiki for information about contributing to Emscripten:
[Contribution section on wiki](https://github.com/kripken/emscripten/wiki#contributing)
-
diff --git a/README.md b/README.md
index 81a95141..6b4778bf 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,26 @@
+![emscripten logo](media/switch_logo.jpeg)
-![logo](http://dl.dropbox.com/u/80664946/emscripten_logo.jpg)
-
-Emscripten
-==========
-
-Emscripten is an LLVM-to-JavaScript compiler. It takes LLVM bitcode - which can be generated from C/C++, using llvm-gcc or clang, or any other language that can be converted into LLVM - and compiles that into JavaScript, which can be run on the web (or anywhere else JavaScript can run).
+Emscripten is an LLVM-to-JavaScript compiler. It takes LLVM bitcode - which can be generated
+from C/C++, using `llvm-gcc` (DragonEgg) or `clang`, or any other language that can be
+converted into LLVM - and compiles that into JavaScript, which can be run on the web (or
+anywhere else JavaScript can run).
Links to **demos**, **tutorial**, **FAQ**, etc: <https://github.com/kripken/emscripten/wiki>
Main project page: <http://emscripten.org>
-Emscripten is MIT licensed, see LICENSE.txt.
+License
+-------
+
+Emscripten is available under 2 licenses, the MIT license and the
+University of Illinois/NCSA Open Source License.
+
+Both are permissive open source licenses, with little if any
+practical difference between them.
+
+The reason for offering both is that (1) the MIT license is
+well-known, while (2) the University of Illinois/NCSA Open Source
+License allows Emscripten's code to be integrated upstream into
+LLVM, which uses that license, should the opportunity arise.
+See `LICENSE` for the full content of the licenses.
diff --git a/src/relooper/README.md b/src/relooper/README.md
index 9b0187b3..a4073a77 100644
--- a/src/relooper/README.md
+++ b/src/relooper/README.md
@@ -1,14 +1,12 @@
-
Relooper
========
-This is an optimized C++ implemention of the Relooper algorithm originally
-developed as part of Emscripten. This implementation includes optimizations
-added since the original academic paper [1] - see paper.pdf - was published
-about it, and is written in an LLVM-friendly way with the goal of inclusion
-in upstream LLVM.
-
-License: MIT&LLVM
-
-[1] Alon Zakai. 2011. Emscripten: an LLVM-to-JavaScript compiler. In Proceedings of the ACM international conference companion on Object oriented programming systems languages and applications companion (SPLASH '11). ACM, New York, NY, USA, 301-312. DOI=10.1145/2048147.2048224 http://doi.acm.org/10.1145/2048147.2048224
+This is an optimized C++ implemention of the Relooper algorithm originally developed as part
+of Emscripten. This implementation includes optimizations added since the original academic
+paper [1] - see paper.pdf - was published about it, and is written in an LLVM-friendly way
+with the goal of inclusion in upstream LLVM.
+[1] Alon Zakai. 2011. Emscripten: an LLVM-to-JavaScript compiler. In Proceedings of the ACM
+international conference companion on Object oriented programming systems languages and
+applications companion (SPLASH '11). ACM, New York, NY, USA, 301-312.
+DOI=10.1145/2048147.2048224 http://doi.acm.org/10.1145/2048147.2048224