Skip to content

Commit

Permalink
Final Cleanup (#65)
Browse files Browse the repository at this point in the history
* Cleanup

* Shuttle updates
  • Loading branch information
Kuly14 authored Jun 3, 2024
1 parent ff8b0cf commit 52d046b
Show file tree
Hide file tree
Showing 34 changed files with 104 additions and 1,688 deletions.
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/BUG-FORM.yml

This file was deleted.

34 changes: 0 additions & 34 deletions .github/ISSUE_TEMPLATE/FEATURE-FORM.yml

This file was deleted.

5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

Binary file removed .github/compilation-benchmark.png
Binary file not shown.
Binary file removed .github/demo.gif
Binary file not shown.
Binary file removed .github/logo.png
Binary file not shown.
35 changes: 0 additions & 35 deletions CHANGELOG.md

This file was deleted.

195 changes: 0 additions & 195 deletions CONTRIBUTING.md

This file was deleted.

34 changes: 7 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,21 @@
## Installation
Before installing please make sure you have the latest rustc installed along with cargo, and you are running the latest stable release.

If you are not sure, you can just run:
1. Run
```console
rustup default stable
curl -L https://up.foxar.dev/ | bash
```

For now the best way to install foxar is:
1. Clone the repo
2. Then just run foxarup
```console
git clone https://github.com/bchainhub/foxar.git
foxarup
```

2. Go to `foxar/foxarup/
```console
cd foxar/foxarup/
```
Foxarup will download the latest binaries from github. After foxarup finishes you can use all binaries.

3. Install foxarup
```console
./install
```
For more information and more custom instalation of foxar, check out the README in [foxarup/](https://github.com/bchainhub/foxar/tree/master/foxarup) folder.

4. Run foxarup

```console
foxarup --path ../
```

This will compile the entire project and will install all your binaries to ~/.foxar.
Now just restart your terminal and you can use one of the binaries. For reference here are the changed names:

Here are the references to the original foundry names:
forge: spark
anvil: shuttle
chisel: pilot
cast: probe

Later we will release binaries to github so the script will be able to just download them, but for now this is the best way.

## Acknowledgements
2 changes: 1 addition & 1 deletion abi/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = "0.1.0"
edition = "2021"
license = "MIT OR Apache-2.0"
readme = "README.md"
description = "Foxar's Solidity ABI bindings"
description = "Foxar's Ylem ABI bindings"
repository = "https://github.com/foxar-rs/foxar"
exclude = ["abi", "build.rs"]

Expand Down
2 changes: 1 addition & 1 deletion abi/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# foxar-abi

Contains automatically-generated Rust bindings from Solidity ABI.
Contains automatically-generated Rust bindings from Ylem ABI.

Additional bindings can be generated by doing the following:

Expand Down
Loading

0 comments on commit 52d046b

Please sign in to comment.