leo/README.md
Collin Chin c48c227894
Update README.md
Signed-off-by: Collin Chin <16715212+collinc97@users.noreply.github.com>
2023-07-07 08:21:01 -07:00

15 KiB
Raw Blame History

The Leo Programming Language

Leo is a functional, statically-typed programming language built for writing private applications.

Table of Contents

🍎 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. The language is currently in an alpha stage and is subject to breaking changes.

⚙️ Build Guide

🦀 Install Rust

We recommend installing Rust using rustup. You can install rustup as follows:

  • macOS or Linux:

    curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
    
  • Windows (64-bit):

    Download the Windows 64-bit executable and follow the on-screen instructions.

  • Windows (32-bit):

    Download the Windows 32-bit executable and follow the on-screen instructions.

🐙 Build from Source Code

We recommend installing Leo by building from the source code as follows:

# 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:

leo

🚀 Quick Start

Use the Leo CLI to create a new project

# 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.

🧰 Troubleshooting

If you are having trouble installing and using Leo, please check out our guide.

If the issue still persists, please open an issue.

📖 Documentation

🤝 Contributing

Please see our guidelines in the developer documentation

❤️ Contributors

Thank you for helping make Leo better!
What do the emojis mean?🧐

d0cd
d0cd

💻 🚧 💬 👀
Collin Chin
Collin Chin

💻 📖 🚧 👀
Howard Wu
Howard Wu

🤔 🚧 🔬 👀
Alessandro Coglio
Alessandro Coglio

📖 🚧 💬 👀
Eric McCarthy
Eric McCarthy

📖 🚧 💬 👀
Raymond Chu
Raymond Chu

🤔 💻 🔬
ljedrz
ljedrz

🐛 💻 💬
Mazdak Farrokhzad
Mazdak Farrokhzad

💻
Damir Shamanaev
Damir Shamanaev

💻
gluax
gluax

💻
0rphon
0rphon

💻
Max Bruce
Max Bruce

💻
Sergey Isaev
Sergey Isaev

💻
Francisco Strambini
Francisco Strambini

💻
François Garillot
François Garillot

💻
Weikeng Chen
Weikeng Chen

🔬
sptg
sptg

🐛 💻
LouisWT
LouisWT

💻
yuliyu123
yuliyu123

💻
detailyang
detailyang

💻
Tom-OriginStorage
Tom-OriginStorage

💻
omahs
omahs

💻
Haruka
Haruka

🐛 💻
swift-mx
swift-mx

💻
allcontributors[bot]
allcontributors[bot]

📖
actions-user[bot]
actions-user[bot]

📖
dependabot[bot]
dependabot[bot]

📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

🛡️ License

License: GPL v3