diff --git a/.all-contributorsrc b/.all-contributorsrc index 4ca9f7eddc..4e34e0bd11 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -25,6 +25,76 @@ "question", "review" ] + }, + { + "login": "collinc97", + "name": "Collin Chin", + "avatar_url": "https://avatars.githubusercontent.com/u/16715212?v=4", + "profile": "http://leo-lang.org", + "contributions": [ + "code", + "doc", + "maintenance", + "review" + ] + }, + { + "login": "howardwu", + "name": "Howard Wu", + "avatar_url": "https://avatars.githubusercontent.com/u/9260812?v=4", + "profile": "https://github.com/howardwu", + "contributions": [ + "ideas", + "maintenance", + "research", + "review" + ] + }, + { + "login": "acoglio", + "name": "Alessandro Coglio", + "avatar_url": "https://avatars.githubusercontent.com/u/2409151?v=4", + "profile": "http://www.kestrel.edu/~coglio", + "contributions": [ + "doc", + "research", + "question", + "review" + ] + }, + { + "login": "bendyarm", + "name": "Eric McCarthy", + "avatar_url": "https://avatars.githubusercontent.com/u/7607035?v=4", + "profile": "http://www.kestrel.edu/home/people/mccarthy/", + "contributions": [ + "doc", + "research", + "question", + "review" + ] + }, + { + "login": "raychu86", + "name": "Raymond Chu", + "avatar_url": "https://avatars.githubusercontent.com/u/14917648?v=4", + "profile": "https://github.com/raychu86", + "contributions": [ + "ideas", + "code", + "research" + ] + }, + { + "login": "ljedrz", + "name": "ljedrz", + "avatar_url": "https://avatars.githubusercontent.com/u/3750347?v=4", + "profile": "https://github.com/ljedrz", + "contributions": [ + "bug", + "code", + "question" + ] } ] } diff --git a/README.md b/README.md index 10549fd545..71075e09ea 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@
-
+
@@ -15,19 +15,19 @@ Leo is a functional, statically-typed programming language built for writing pri
## Table of Contents
-* [1. Overview](#1-overview)
-* [2. Build Guide](#2-build-guide)
- * [2.1 Install Rust](#21-install-rust)
- * [2.2 Build from Source Code](#22-build-from-source-code)
-* [3. Quick Start](#3-quick-start)
-* [4. Troubleshooting](#4-troubleshooting)
-* [5. Documentation](#5-documentation)
-* [6. Contributing](#6-contributing)
-* [7. Contributors](#7-contributors)
-* [8. License](#8-license)
+* [1. Overview 🍎](#1-overview)
+* [2. Build Guide ⚙️️](#2-build-guide)
+ * [2.1 Install Rust 🦀](#21-install-rust)
+ * [2.2 Build from Source Code 🐙](#22-build-from-source-code)
+* [3. Quick Start 🚀](#3-quick-start)
+* [4. Troubleshooting 🧰](#4-troubleshooting)
+* [5. Documentation 📖](#5-documentation)
+* [6. Contributing 🤝](#6-contributing)
+* [7. Contributors ❤️](#7-contributors)
+* [8. License 🛡️](#8-license)
-## 1. Overview
+## 1. Overview 🍎
Welcome to the Leo programming language.
@@ -40,9 +40,9 @@ Leo offers developers with tools to sanity check circuits including unit tests,
Leo is one part of a greater ecosystem for building private applications on [Aleo](https://aleo.org/).
The language is currently in an alpha stage and is subject to breaking changes.
-## 2. Build Guide
+## 2. Build Guide ⚙️️
-### 2.1 Install Rust
+### 2.1 Install Rust 🦀
We recommend installing Rust using [rustup](https://www.rustup.rs/). You can install `rustup` as follows:
@@ -59,7 +59,7 @@ We recommend installing Rust using [rustup](https://www.rustup.rs/). You can ins
Download the [Windows 32-bit executable](https://win.rustup.rs/i686) and follow the on-screen instructions.
-### 2.2 Build from Source Code
+### 2.2 Build from Source Code 🐙
We recommend installing Leo by building from the source code as follows:
@@ -77,7 +77,7 @@ Now to use leo, in your terminal, run:
leo
```
-## 3. Quick Start
+## 3. Quick Start 🚀
Use the Leo CLI to create a new project
@@ -96,25 +96,26 @@ The `leo run` command will compile the program into Aleo instructions and run it
Congratulations! You've just run your first Leo program.
-## 4. Troubleshooting
+## 4. Troubleshooting 🧰
If you are having trouble installing and using Leo, please check out our [guide](docs/troubleshooting.md).
If the issue still persists, please [open an issue](https://github.com/AleoHQ/leo/issues/new/choose).
-## 5. Documentation
+## 5. Documentation 📖
* [Hello World - Next Steps](https://developer.aleo.org/leo/hello)
* [Leo Language Documentation](https://developer.aleo.org/leo/language)
* [Leo ABNF Grammar](./docs/grammar/abnf-grammar.txt)
* [Homepage](https://developer.aleo.org/overview/)
-## 6. Contributing
+## 6. Contributing 🤝
Please see our guidelines in the [developer documentation](./CONTRIBUTING.md)
-Thank you for helping make Leo better!
-## 7. Contributors
+## 7. Contributors ❤️
+Thank you for helping make Leo better!
+[What do the emojis mean?🧐](https://allcontributors.org/docs/en/emoji-key)
@@ -123,6 +124,12 @@ Thank you for helping make Leo better!