Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
garyghayrat committed Feb 15, 2024
1 parent e7f405a commit f0070f1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 14 deletions.
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016-2023 zOS Global Limited and contributors
Copyright (c) 2024 ScopeLift

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
Expand All @@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
32 changes: 20 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,9 @@ This repo is developed using [Foundry](https://book.getfoundry.sh/).

### Setup

1. Install [Foundry](https://book.getfoundry.sh/getting-started/installation) on your local machine by opening the terminal and running the following command:
1. Install Foundry on your local machine by following the [instructions here](https://book.getfoundry.sh/getting-started/installation).

```sh
curl -L https://foundry.paradigm.xyz | bash
```

2. Clone the repo and navigate to the root directory of the repo.
2. Clone the repo and navigate to the root directory of the repo:

```sh
git clone [email protected]:ScopeLift/stealth-address-erc-contracts.git
Expand Down Expand Up @@ -45,23 +41,35 @@ forge test
forge coverage
```

### Specifications
### Linting and Specifications

#### Pre-requisites
This project uses [scopelint](https://github.com/ScopeLift/scopelint) for linting and spec generation. Follow [these instructions](https://github.com/ScopeLift/scopelint?tab=readme-ov-file#installation) to install it.

1. Install the [rust toolchain](https://www.rust-lang.org/tools/install).
2. Run `cargo install scopelint`
#### Lint

#### See contract specifications
```bash
# Check formatting
scopelint check
# Apply formatting changes
scopelint fmt
```

```sh
#### Spec

```bash
scopelint spec
```

This command will use the names of the contract's unit tests to generate a human readable spec. It will list each contract, its constituent functions, and the human readable description of functionality each unit test aims to assert.

## Deployments

Coming soon.

## Security

Coming soon.

## License

Contracts in this repository are released under the [MIT License](https://github.com/ScopeLift/stealth-address-erc-contracts/blob/main/LICENSE).

0 comments on commit f0070f1

Please sign in to comment.