Merge pull request #14 from wasmerio/readme-license

chore: Update readme and add license

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-present Wasmer, Inc. and its affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,25 +1,40 @@
-# LLVM Custom Builds
+<div align="center">
+  <a href="https://wasmer.io" target="_blank" rel="noopener noreferrer">
+    <img width="300" src="https://raw.githubusercontent.com/wasmerio/wasmer/master/assets/logo.png" alt="Wasmer logo">
+  </a>
+
+  <h1>LLVM Custom Builds</h1>
+
+  <p>
+    <a href="https://github.com/wasmerio/llvm-custom-builds/actions?query=workflow%3A%22Build%22">
+      <img src="https://github.com/wasmerio/llvm-custom-builds/workflows/Build/badge.svg" alt="Build Status">
+    </a>
+    <a href="https://github.com/wasmerio/llvm-custom-builds/blob/master/LICENSE">
+      <img src="https://img.shields.io/github/license/wasmerio/llvm-custom-builds.svg" alt="License">
+    </a>
+  </p>
 
-> Go along your path, this is a dangerous place.
+  <h3>
+    <a href="https://wasmer.io/">Website</a>
+    <span> • </span>
+    <a href="https://docs.wasmer.io">Docs</a>
+    <span> • </span>
+    <a href="https://slack.wasmer.io/">Slack Channel</a>
+  </h3>
 
-This repository contains a small `build.sh` script that builds
-LLVM. The version of LLVM is defined by the `.gitmodules` file. The
-build is run by [Github
-Actions](https://github.com/Hywan/llvm-custom-builds/actions) on 3
-platforms: Linux (Ubuntu), Darwin (macOS), and Windows, all
-AMD64. Builds are attached to [Github releases as
-assets](https://github.com/Hywan/llvm-custom-builds/releases).
+</div>
 
-## Branches
+<hr/>
 
-This repository comes with 3 branches that map to specific LLVM
-branches:
+> Go along your path, this is a dangerous place.
 
-| Branch of this repository… | … maps to LLVM branch |
-|-|-|
-| `master` | `release/llvm-11.x` |
-| `llvm-11.x` | `release/llvm-11.x` |
-| `llvm-10.x` | `release/llvm-10.x` |
+This repository contains a small `build.sh` (or `build.ps1` for Windows 
+PowerShell) script that builds LLVM. The version of LLVM is defined by 
+the `.gitmodules` file. The build is run by [Github
+Actions](https://github.com/wasmerio/llvm-custom-builds/actions) on 3
+platforms: Linux (Ubuntu), Darwin (macOS), and Windows, all
+AMD64. Builds are attached to [Github releases as
+assets](https://github.com/wasmerio/llvm-custom-builds/releases).
 
 ## Prebuilds
 
@@ -30,43 +45,36 @@ branches:
       <th>Architecture</th>
       <th>Platform</th>
       <th>Package</th>
-      <th>Size</th>
     </tr>
   </thead>
   <tbody>
     <tr>
       <td rowspan="3">11</td>
       <td rowspan="3">amd64</td>
       <td>Darwin</td>
-      <td><a href="https://github.com/Hywan/llvm-custom-builds/releases/download/11.x/darwin-amd64.tar.gz">download</a></td>
-      <td>377Mb</td>
+      <td><a href="https://github.com/wasmerio/llvm-custom-builds/releases/download/11.x/darwin-amd64.tar.gz">download</a></td>
     </tr>
     <tr>
       <td>Linux</td>
-      <td><a href="https://github.com/Hywan/llvm-custom-builds/releases/download/11.x/linux-amd64.tar.gz">download</a></td>
-      <td>486Mb</td>
+      <td><a href="https://github.com/wasmerio/llvm-custom-builds/releases/download/11.x/linux-amd64.tar.gz">download</a></td>
     </tr>
     <tr>
       <td>Windows</td>
-      <td><a href="https://github.com/Hywan/llvm-custom-builds/releases/download/11.x/windows-amd64.tar.gz">download</a></td>
-      <td>619Mb</td>
+      <td><a href="https://github.com/wasmerio/llvm-custom-builds/releases/download/11.x/windows-amd64.tar.gz">download</a></td>
     </tr>
     <tr>
       <td rowspan="3">10</td>
       <td rowspan="3">amd64</td>
       <td>Darwin</td>
-      <td><a href="https://github.com/Hywan/llvm-custom-builds/releases/download/10.x/darwin-amd64.tar.gz">download</a></td>
-      <td>353Mb</td>
+      <td><a href="https://github.com/wasmerio/llvm-custom-builds/releases/download/10.x/darwin-amd64.tar.gz">download</a></td>
     </tr>
     <tr>
       <td>Linux</td>
-      <td><a href="https://github.com/Hywan/llvm-custom-builds/releases/download/10.x/linux-amd64.tar.gz">download</a></td>
-      <td>457Mb</td>
+      <td><a href="https://github.com/wasmerio/llvm-custom-builds/releases/download/10.x/linux-amd64.tar.gz">download</a></td>
     </tr>
     <tr>
       <td>Windows</td>
-      <td><a href="https://github.com/Hywan/llvm-custom-builds/releases/download/10.x/windows-amd64.tar.gz">download</a></td>
-      <td>589Mb</td>
+      <td><a href="https://github.com/wasmerio/llvm-custom-builds/releases/download/10.x/windows-amd64.tar.gz">download</a></td>
     </tr>
   </tbody>
 </table>
@@ -78,18 +86,21 @@ The following configuration is the one used for all actual prebuilds:
 | Options | Value |
 |-|-|
 | `clang` | enabled |
-| `terminfo` | disabled |
-| `zlib` | disabled |
 | `docs` | not included |
 | `examples` | not included |
 | `go_tests` | not included |
+| `lld` | enabled |
+| `optimized_tablegen` | enabled |
+| `targets_to_build` | `X86` + `AArch64` |
+| `terminfo` | disabled |
 | `tests` | not included |
 | `tools` | included |
 | `utils` | not included |
-| `optimized_tablegen` | enabled |
-| `targets_to_build` | `X86` + `AArch64` |
+| `zlib` | disabled |
+
+# License
+
+The entire project is under the MIT License. Please read [the `LICENSE` file][license].
 
-## License
 
-Do whatever you want. No license. It's free. You're free. I'm not
-responsible of what you're doing with that.
+[license]: https://github.com/wasmerio/llvm-custom-builds/blob/master/LICENSE