Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ECO-1708] Update README.md to make the git submodule process clearer #11

Merged
merged 3 commits into from
May 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,14 @@ First, clone this project: `git clone https://github.com/econia-labs/inbox`.

Then, clone git submodules: `git submodule update --init --recursive`.

NOTE: If you are running this command from the [emojicoin dot fun] repository,
you need to specify that you only want to update `src/inbox` if you don't have
access to the private TradingView `charting_library` repository.

```shell
git submodule update --init --recursive src/inbox
```

### Step 1: Configuration

Copy `example.env` to `.env` and update the required fields. Field
Expand Down Expand Up @@ -103,3 +111,5 @@ CREATE TRIGGER notify_event
```

This will emit an MQTT event with the topic as your event type for all your contract's events.

[emojicoin dot fun]: https://github.com/econia-labs/emojicoin-dot-fun
1 change: 1 addition & 0 deletions cfg/cspell-dictionary.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ chrono
clippy
devnet
econialabs
emojicoin
eventloop
eventpoll
hadolint
Expand Down
Loading