Browse Source

Update installation instructions for MacOS (#940)

Signed-off-by: Lucas Steuernagel <lucas.tnagel@gmail.com>
Lucas Steuernagel 3 years ago
parent
commit
6ca82a8792
3 changed files with 25 additions and 2 deletions
  1. 12 2
      README.md
  2. 2 0
      RELEASE_CHECKLIST.md
  3. 11 0
      docs/installing.rst

+ 12 - 2
README.md

@@ -14,10 +14,20 @@ some caveats due to differences in the underlying blockchain.
 Solang is under active development right now, and has
 Solang is under active development right now, and has
 [extensive documentation](https://solang.readthedocs.io/en/latest/).
 [extensive documentation](https://solang.readthedocs.io/en/latest/).
 
 
+
+## Installation
+
+Solang is available as a Brew cask for MacOS, with the following command:
+
+```
+brew install hyperledger-labs/solang/solang
+```
+
+For other operating systems, please check the [installation guide](https://solang.readthedocs.io/en/latest/installing.html).
+
 ## Simple example
 ## Simple example
 
 
-First build [Solang](https://solang.readthedocs.io/en/latest/installing.html)
-or use the container, then write the following to flipper.sol:
+After installing the compiler, write the following to flipper.sol:
 
 
 ```solidity
 ```solidity
 contract flipper {
 contract flipper {

+ 2 - 0
RELEASE_CHECKLIST.md

@@ -16,3 +16,5 @@
 - `cargo publish`
 - `cargo publish`
 - Release new version of vscode plugin if needed
 - Release new version of vscode plugin if needed
 - Mention release in Discord (Solana, Hyperledger) and Hyperledger /dev/weekly
 - Mention release in Discord (Solana, Hyperledger) and Hyperledger /dev/weekly
+- Update the version number and the MacOS binaries' sha256 hash in `Casks/solang.rb` under
+  the repository `hyperledger-labs/homebrew-solang`.

+ 11 - 0
docs/installing.rst

@@ -3,6 +3,17 @@ Installing Solang
 
 
 The Solang compiler is a single binary. It can be installed in different ways.
 The Solang compiler is a single binary. It can be installed in different ways.
 
 
+
+Download from Brew
+------------------
+
+Solang is available on Brew via a private tap. Currently, this works only for MacOS systems, both Intel and Apple Silicon.
+To install Solang via Brew, run the following command:
+
+.. code-block:: text
+
+    brew install hyperledger-labs/solang/solang
+
 Download release binaries
 Download release binaries
 -------------------------
 -------------------------