-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* doc: add cli docs in getting started * fix(docs): fix docs link
- Loading branch information
1 parent
dc5609b
commit 1bc288d
Showing
20 changed files
with
160 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Getting started | ||
|
||
This tutorial guides you through building a static library with the Circom/Halo2 adapter for Android and iOS and creating example templates for mobile development. | ||
|
||
## 0. Prerequisites | ||
|
||
Make sure you've installed the [prerequisites](/docs/prerequisites). | ||
|
||
## 1. Install CLI | ||
|
||
Clone the `mopro` repository and install the `mopro` CLI tool. | ||
|
||
```sh | ||
git clone https://github.com/zkmopro/mopro | ||
cd mopro/cli | ||
cargo install --path . | ||
cd ../.. | ||
``` | ||
|
||
## 2. Initialize adapters | ||
|
||
Navigate to the folder where you want to build the app. Select the adapters using the `mopro` CLI. | ||
|
||
```sh | ||
mopro init | ||
``` | ||
|
||
## 3. Build bindings | ||
|
||
Navigate to your project directory. (e.g. `cd mopro-example-app`) <br/> | ||
Build bindings for specific targets (iOS, Android). | ||
|
||
```sh | ||
mopro build | ||
``` | ||
|
||
:::warning | ||
The process of building bindings may take a few minutes. | ||
::: | ||
|
||
:::info | ||
Running your project in `release` mode significantly enhances performance compared to `debug` mode. This is because the Rust compiler applies optimizations that improve runtime speed and reduce binary size, making your application more efficient. | ||
|
||
::: | ||
|
||
## 4. Create templates | ||
|
||
Create templates for developing your mobile app. | ||
|
||
```sh | ||
mopro create | ||
``` | ||
|
||
Follow the instructions to open development tools | ||
|
||
For iOS: | ||
```sh | ||
open ios/MoproApp.xcodeproj | ||
``` | ||
|
||
For Android | ||
```sh | ||
open android -a Android\ Studio | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/docs/getting-started/android-setup.md → docs/docs/setup/android-setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
docs/docs/getting-started/ios-setup.md → docs/docs/setup/ios-setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
# Getting started | ||
|
||
This tutorial guides you through building a static library with the Circom/Halo2 adapter for Android and iOS and creating example templates for mobile development. | ||
|
||
## 0. Prerequisites | ||
|
||
Make sure you've installed the [prerequisites](/docs/prerequisites). | ||
|
||
## 1. Install CLI | ||
|
||
Clone the `mopro` repository and install the `mopro` CLI tool. | ||
|
||
```sh | ||
git clone https://github.com/zkmopro/mopro | ||
cd mopro/cli | ||
cargo install --path . | ||
cd ../.. | ||
``` | ||
|
||
## 2. Initialize adapters | ||
|
||
Navigate to the folder where you want to build the app. Select the adapters using the `mopro` CLI. | ||
|
||
```sh | ||
mopro init | ||
``` | ||
|
||
## 3. Build bindings | ||
|
||
Navigate to your project directory. (e.g. `cd mopro-example-app`) <br/> | ||
Build bindings for specific targets (iOS, Android). | ||
|
||
```sh | ||
mopro build | ||
``` | ||
|
||
:::warning | ||
The process of building bindings may take a few minutes. | ||
::: | ||
|
||
:::info | ||
Running your project in `release` mode significantly enhances performance compared to `debug` mode. This is because the Rust compiler applies optimizations that improve runtime speed and reduce binary size, making your application more efficient. | ||
|
||
::: | ||
|
||
## 4. Create templates | ||
|
||
Create templates for developing your mobile app. | ||
|
||
```sh | ||
mopro create | ||
``` | ||
|
||
Follow the instructions to open development tools | ||
|
||
For iOS: | ||
```sh | ||
open ios/MoproApp.xcodeproj | ||
``` | ||
|
||
For Android | ||
```sh | ||
open android -a Android\ Studio | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...on-0.1.0/getting-started/android-setup.md → ...docs/version-0.1.0/setup/android-setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
...ersion-0.1.0/getting-started/ios-setup.md → ...ned_docs/version-0.1.0/setup/ios-setup.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters