Skip to content

Commit

Permalink
Cleanup out dated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
d0cd committed Aug 18, 2022
1 parent 7f37b2f commit eb4ee14
Show file tree
Hide file tree
Showing 45 changed files with 9 additions and 4,680 deletions.
26 changes: 0 additions & 26 deletions FAQs.md

This file was deleted.

31 changes: 8 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,8 @@ integrate private applications into your stack. Leo compiles to circuits making
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/). If your goal is to build a user experience
on the web that is both truly personal and truly private, then we recommend downloading the [Aleo Studio IDE](https://aleo.studio/)
and checking out the [Aleo Package Manager](https://aleo.pm/).
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

Expand All @@ -58,22 +57,9 @@ 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.2a Build from Crates.io
### 2.2 Build from Source Code

We recommend installing Leo this way. In your terminal, run:

```bash
cargo install leo-lang
```

Now to use Leo, in your terminal, run:
```bash
leo
```

### 2.2b Build from Source Code

Alternatively, you can install Leo by building from the source code as follows:
We recommend installing Leo by building from the source code as follows:

```bash
# Download the source code
Expand All @@ -95,25 +81,24 @@ Use the Leo CLI to create a new project

```bash
# create a new `hello-world` Leo project
leo new hello-world
cd hello-world
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 main program, generate keys for a trusted setup, fetch inputs, generate a proof and verify it.
The `leo run` command will compile the program into Aleo instructions and run it.

Congratulations! You've just run your first Leo program.

## 4. Documentation

* [Hello World - Next Steps](https://developer.aleo.org/developer/getting_started/hello_world)
* [Leo Language Documentation](https://developer.aleo.org/developer/language/layout)
* [Leo ABNF Grammar](./grammar/README.md)
* [Leo CLI Documentation](https://developer.aleo.org/developer/cli/new)
* [Leo ABNF Grammar](./docs/grammar/abnf-grammar.txt)
* [Homepage](https://developer.aleo.org/developer/getting_started/overview)

## 5. Contributing
Expand Down
10 changes: 1 addition & 9 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,8 @@

The following describes our procedure for addressing major and minor security concerns in Leo.

## Testnet I

As Aleo is currently in the prototype stage and does not operate a platform intended for production use,
our security procedures are designed to promote public disclosure and quick security resolution.

In preparation for the production stage, we will release new security guidelines and
issue new procedures for addressing the disclosure of sensitive security vulnerabilities.

### Reporting a Bug

During Testnet I, all software bugs should be reported by filing a Github issue.
During Testnet 3, all software bugs should be reported by filing a Github issue.

If you are unsure and would like to reach out to us directly, please email security \_at\_ aleo.org to elaborate on the issue.
Loading

0 comments on commit eb4ee14

Please sign in to comment.