Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
Signed-off-by: Luis Mastrangelo <[email protected]>
  • Loading branch information
acuarica committed May 28, 2024
1 parent ebb441a commit 99d3bcc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,17 @@ Make sure both the `server` submodule [`sourcify`](./sourcify/) and the `reposit
git submodule update --init --recursive
```

These repo submodules are the `server` and `repository` Sourcify upstream services.
These repo submodules are `sourcify` and `h5ai-nginx`, which corresponds to the `server` and `repository` Sourcify upstream services respectively.
Instead of forking those repos, we attach them here directly in order to consume upstream updates more easily.
Given that the `ui` changes are Hedera specific, we decided to keep our [`ui`](./ui/) fork with custom modifications.

Apply the Hedera customization patch to both the `sourcify` and `h5ai-nginx` submodules **(execute this only once)**

```sh
npm run server:patch
npm run repository:patch
```

## Quick Start

To start the services `server`, `repository` and `ui` run
Expand Down
4 changes: 4 additions & 0 deletions tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,10 @@ module.exports = {
};
```

> [!NOTE]
> Both `apiUrl` and `browserUrl` expect an URL without a trailing slash.
> Having a trailing slash in the Sourcify URLs may cause unexpected errors.
Note that the `hardhat-verify` plugin has Etherscan enabled by default, and Sourcify disabled by default, hence you need to set both flags as above in the configuration.

Then run
Expand Down

0 comments on commit 99d3bcc

Please sign in to comment.