Skip to content

Commit

Permalink
chore: remove unused files and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
vivianjeng authored and oskarth committed Mar 12, 2024
1 parent 0b3a731 commit ad76e92
Show file tree
Hide file tree
Showing 16 changed files with 16 additions and 635 deletions.
3 changes: 3 additions & 0 deletions mopro-android/Example/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,6 @@
.externalNativeBuild
.cxx
local.properties
gradle
gradlew.bat
gradlew
2 changes: 0 additions & 2 deletions mopro-android/Example/app/src/main/AndroidManifest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@

<application
android:allowBackup="true"
android:dataExtractionRules="@xml/data_extraction_rules"
android:fullBackupContent="@xml/backup_rules"
android:icon="@mipmap/ic_launcher"
android:label="@string/app_name"
android:roundIcon="@mipmap/ic_launcher_round"
Expand Down
13 changes: 0 additions & 13 deletions mopro-android/Example/app/src/main/res/xml/backup_rules.xml

This file was deleted.

This file was deleted.

Binary file not shown.

This file was deleted.

185 changes: 0 additions & 185 deletions mopro-android/Example/gradlew

This file was deleted.

89 changes: 0 additions & 89 deletions mopro-android/Example/gradlew.bat

This file was deleted.

20 changes: 13 additions & 7 deletions mopro-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Here are the basic commands of `mopro`:

Initialize, build and test a circuit with Rust bindings:

```
```sh
# Set MOPRO_ROOT
export MOPRO_ROOT=/Users/user/repos/github.com/oskarth/mopro

Expand All @@ -56,12 +56,15 @@ mopro test

Initialize and build an app with iOS support.

```
```sh
mopro init --platforms ios
cd mopro-example-app
mopro prepare
mopro build --platforms ios

# Open project in XCode
open ios/ExampleApp/ExampleApp.xcworkspace

# Currently testing only available for Rust bindings,
# Can run iOS tests from newly created Xcode project
mopro test
Expand All @@ -72,18 +75,21 @@ mopro test
Initialize and build an app with Android support.
> Currently support [Android Studio](https://developer.android.com/studio)
```
```sh
mopro init --platforms android
cd mopro-example-app
mopro prepare
mopro build --platforms android

# Open android project in Android Studio
open android -a Android\ Studio
```

### Exporting bindings

To export bindings to a different directory:

`mopro export-bindings --destination <DESTINATION_DIR> --platforms <IOS_OR_ANDROID>`
`mopro export-bindings --destination <DESTINATION_DIR> --platforms <IOS_AND_OR_ANDROID>`

This will the following files, assuming they've been built, to the destination directory:

Expand All @@ -98,9 +104,9 @@ This will the following files, assuming they've been built, to the destination d
```
├── KotlinBindings
│   └── mopro.kt
── JniLibs
   └── <ARCHITECTURE>
│  └── libuniffi_mopro.so
── JniLibs
   └── <ARCHITECTURE>
└── libuniffi_mopro.so
```

## Contributing
Expand Down
Loading

0 comments on commit ad76e92

Please sign in to comment.