mirror of
https://github.com/AleoHQ/leo.git
synced 2024-09-11 15:05:33 +03:00
* docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
146 lines
5.1 KiB
Markdown
146 lines
5.1 KiB
Markdown
<p align="center">
|
|
<img width="1412" src="https://cdn.aleo.org/leo/banner.png">
|
|
</p>
|
|
|
|
<h1 align="center">The Leo Programming Language</h1>
|
|
|
|
<p align="center">
|
|
<a href="https://circleci.com/gh/AleoHQ/leo"><img src="https://circleci.com/gh/AleoHQ/leo.svg?style=svg&circle-token=6e9ad6d39d95350544f352d34e0e5c62ef54db26"></a>
|
|
<a href="https://codecov.io/gh/AleoHQ/leo"><img src="https://codecov.io/gh/AleoHQ/leo/branch/testnet3/graph/badge.svg?token=S6MWO60SYL"/></a>
|
|
<a href="https://discord.gg/5v2ynrw2ds"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a>
|
|
<a href="https://allcontributors.org/"><img src="https://img.shields.io/github/all-contributors/AleoHQ/leo?color=ee8449&style=flat-square"/></a>
|
|
</p>
|
|
|
|
Leo is a functional, statically-typed programming language built for writing private applications.
|
|
|
|
## <a name='TableofContents'></a>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
|
|
|
|
Welcome to the Leo programming language.
|
|
|
|
Leo provides a high-level language that abstracts low-level cryptographic concepts and makes it easy to
|
|
integrate private applications into your stack. Leo compiles to circuits making zero-knowledge proofs practical.
|
|
|
|
The syntax of Leo is influenced by traditional programming languages like JavaScript, Scala, and Rust, with a strong emphasis on readability and ease-of-use.
|
|
Leo offers developers with tools to sanity check circuits including unit tests, integration tests, and console functions.
|
|
|
|
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.1 Install Rust
|
|
|
|
We recommend installing Rust using [rustup](https://www.rustup.rs/). You can install `rustup` as follows:
|
|
|
|
- macOS or Linux:
|
|
```bash
|
|
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
|
```
|
|
|
|
- Windows (64-bit):
|
|
|
|
Download the [Windows 64-bit executable](https://win.rustup.rs/x86_64) and follow the on-screen instructions.
|
|
|
|
- Windows (32-bit):
|
|
|
|
Download the [Windows 32-bit executable](https://win.rustup.rs/i686) and follow the on-screen instructions.
|
|
|
|
### 2.2 Build from Source Code
|
|
|
|
We recommend installing Leo by building from the source code as follows:
|
|
|
|
```bash
|
|
# Download the source code
|
|
git clone https://github.com/AleoHQ/leo
|
|
cd leo
|
|
|
|
# Install 'leo'
|
|
$ cargo install --path .
|
|
```
|
|
|
|
Now to use leo, in your terminal, run:
|
|
```bash
|
|
leo
|
|
```
|
|
|
|
## 3. Quick Start
|
|
|
|
Use the Leo CLI to create a new project
|
|
|
|
```bash
|
|
# create a new `hello-world` Leo project
|
|
leo new helloworld
|
|
cd helloworld
|
|
|
|
# build & setup & prove & verify
|
|
leo run
|
|
```
|
|
|
|
The `leo new` command creates a new Leo project with a given name.
|
|
|
|
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
|
|
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
|
|
|
|
* [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
|
|
|
|
Please see our guidelines in the [developer documentation](./CONTRIBUTING.md)
|
|
|
|
Thank you for helping make Leo better!
|
|
|
|
## 7. Contributors
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
|
|
<!-- prettier-ignore-start -->
|
|
<!-- markdownlint-disable -->
|
|
<table>
|
|
<tbody>
|
|
<tr>
|
|
<td align="center" valign="top" width="14.28%"><a href="https://github.com/d0cd"><img src="https://avatars.githubusercontent.com/u/23022326?v=4?s=100" width="100px;" alt="d0cd"/><br /><sub><b>d0cd</b></sub></a><br /><a href="https://github.com/AleoHQ/leo/commits?author=d0cd" title="Code">💻</a> <a href="#maintenance-d0cd" title="Maintenance">🚧</a> <a href="#question-d0cd" title="Answering Questions">💬</a> <a href="https://github.com/AleoHQ/leo/pulls?q=is%3Apr+reviewed-by%3Ad0cd" title="Reviewed Pull Requests">👀</a></td>
|
|
</tr>
|
|
</tbody>
|
|
<tfoot>
|
|
<tr>
|
|
<td align="center" size="13px" colspan="7">
|
|
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
|
|
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
|
|
</img>
|
|
</td>
|
|
</tr>
|
|
</tfoot>
|
|
</table>
|
|
|
|
<!-- markdownlint-restore -->
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
## 8. License
|
|
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](./LICENSE.md)
|