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

adding to the journal #266

Merged
merged 6 commits into from
Jan 9, 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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ __pycache__
*.pdf

# notes
journal/book/*
book/*

# ui
Expand Down
10 changes: 0 additions & 10 deletions Makefile.toml

This file was deleted.

8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,14 @@ Interacting with smart contracts that are deployed on Ethereum and other EVM blo
### Solution
Excalibur is an Ethereum Application Client which vertically integrates all components of the EVM tech stack into one package. This enables end users to directly interface with even the lowest parts of the stack, e.g. Ethereum nodes. It also empowers existing capabilities to be more performant, for example, transaction simulation, fetching blockchain data, and transaction execution.

### Journal
You will need to `cargo install mdbook` and `cargo install mdbook-katex` to be able to render the journal properly.
To see the journal you can run from the root directory:
```bash
mdbook serve journal
```
and visit `localhost:3000` in your browser.

## Dependencies
- [Anvil](https://github.com/foundry-rs/foundry) is installed and available in `$PATH`.
- [Forge](https://github.com/foundry-rs/foundry) is installed and available in `$PATH`.
Expand Down
Loading
Loading