Skip to content

Commit

Permalink
snarkVM
Browse files Browse the repository at this point in the history
  • Loading branch information
collinc97 committed Sep 21, 2023
1 parent d5c9ec1 commit 6cbe744
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 14 deletions.
12 changes: 6 additions & 6 deletions documentation/00_aleo_overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: aleo
title: Aleo Instructions and SnarkVM
title: Aleo instructions and snarkVM
sidebar_label: Overview
---
Welcome to the Aleo instructions guide. Aleo instructions is the intermediate representation of Aleo programs.
Expand All @@ -12,15 +12,15 @@ Aleo programs are files with a `.aleo` extension.
Aleo programs contain Aleo instructions - an assembly-like programming language.
Aleo instructions are compiled into AVM opcodes that can be executed by the Aleo Virtual Machine.

Install SnarkVM to compile and execute Aleo instructions.
Install snarkVM to compile and execute Aleo instructions.

:::info
SnarkVM is currently in active development. Please monitor the repository on [**GitHub**](https://github.com/AleoHQ/snarkVM) for possibly breaking changes.
snarkVM is currently in active development. Please monitor the repository on [**GitHub**](https://github.com/AleoHQ/snarkVM) for possibly breaking changes.
:::

## Installing SnarkVM
## Installing snarkVM

Proceed to [**Installation**](./aleo/01_installation.md) for information on how to install SnarkVM.
Proceed to [**Installation**](./aleo/01_installation.md) for information on how to install snarkVM.

## Hello Aleo Instructions

Expand All @@ -40,7 +40,7 @@ Study the formal [ABNF grammar specification](https://github.com/AleoHQ/grammars

## Command Line Interface Documentation

The SnarkVM CLI provides a suite of commands to make programming in Aleo instructions easy.
The snarkVM CLI provides a suite of commands to make programming in Aleo instructions easy.

* [snarkvm new](./aleo/05_commands.md#snarkvm-new)
* [snarkvm build (deprecated)](./aleo/05_commands.md#snarkvm-build)
Expand Down
4 changes: 2 additions & 2 deletions documentation/aleo/01_installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ cargo --version

### 2. Build Source Code

You can install SnarkVM by building from the source code as follows:
You can install snarkVM by building from the source code as follows:

```bash
# Download the source code
Expand All @@ -35,7 +35,7 @@ $ cargo install --path .

This will generate the executable `~/.cargo/bin/snarkvm`.

Now to use the SnarkVM CLI, in your terminal, run:
Now to use the snarkVM CLI, in your terminal, run:
```bash
snarkvm
```
Expand Down
8 changes: 4 additions & 4 deletions documentation/aleo/05_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
id: commands
title: The SnarkVM Command Line Interface
title: The snarkVM Command Line Interface
sidebar_label: Commands
---

Expand Down Expand Up @@ -42,7 +42,7 @@ package-name/

## `snarkvm build`
:::info
This command is deprecated as of SnarkVM `v0.14.5`. It will be removed in a future release.
This command is deprecated as of snarkVM `v0.14.5`. It will be removed in a future release.
:::
To compile your program and verify that it builds properly, run:
```bash
Expand Down Expand Up @@ -103,7 +103,7 @@ snarkvm clean

## `snarkvm update`

To update SnarkVM to the latest version run:
To update snarkVM to the latest version run:
```
snarkvm update
```
Expand All @@ -113,7 +113,7 @@ To list the available versions of Aleo run:
snarkvm update --list
```

To update SnarkVM and suppress outputs to terminal run:
To update snarkVM and suppress outputs to terminal run:
```
snarkvm update --quiet
```
4 changes: 2 additions & 2 deletions documentation/sdk/typescript/00_sdk_overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ function hello:
The SDK provides the ability to execute Aleo Instructions programs %100 client-side within the browser.

The `ProgramManager` object encapsulates the functionality for executing programs and making zero knowledge proofs about
them. Under the hood it uses cryptographic code compiled from [SnarkVM](https://developer.aleo.org/aleo) into WebAssembly.
them. Under the hood it uses cryptographic code compiled from [snarkVM](https://developer.aleo.org/aleo) into WebAssembly.
JavaScript bindings to this WebAssembly code allows execution of programs in zero knowledge fully within the browser
without requiring any external communication with the internet. Users interested in lower level details on how this is
achieved can visit the [aleo-wasm](https://github.com/AleoHQ/sdk/tree/testnet3/wasm) crate.
Expand Down Expand Up @@ -203,7 +203,7 @@ graph LR
❗WebAssembly must be initialized before any SDK functions can be called.

Aleo programs are made zero knowledge through the usage of `ZkSnarks`. The Rust code behind Aleo programs and the ZkSnarks
that make them zero knowledge are hosted in the [SnarkVM Repostiory](https://github.com/AleoHQ/SnarkVM). The Aleo SDK
that make them zero knowledge are hosted in the [snarkVM Repostiory](https://github.com/AleoHQ/SnarkVM). The Aleo SDK
compiles this code to WebAssembly and creates JavaScript bindings, enabling Aleo programs to run directly in the browser.

Before any logic within the SDK is run within the browser however, the WebAssembly module the SDK contains must be
Expand Down

0 comments on commit 6cbe744

Please sign in to comment.