From 3295ff795902b3a942c2b0b8fb72c45d9e1f9e7c Mon Sep 17 00:00:00 2001 From: ttarsi <31632172+ttarsi@users.noreply.github.com> Date: Tue, 21 Jan 2025 02:30:23 -0500 Subject: [PATCH] chore(readme): update repo map (#2841) Update the repo map in readme: - adds sdk and solver - removes subdirectories from this level map, leave that to the directories themselves. less is more issue: none --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 50693c180..0fb041ba0 100644 --- a/README.md +++ b/README.md @@ -36,24 +36,18 @@ _If any of above commands fail, see the [troubleshooting section](./e2e/README.m ## Directory Structure
+├── cli: Omni command line interface. ├── contracts: Solidity contracts and related software. -│ ├── core/: Core protocol smart contracts. -│ ├── avs/: Eigen AVS smart contracts. -│ ├── bindings/: Go smart contract bindings. -│ └── allocs/: Predeploy allocations. -├── docs: Documentation resources, including images and diagrams. -├── halo: The Halo instance, including application logic and attestation mechanisms. -│ ├── app: Application logic for Halo. -│ └── cmd: Command-line tools and utilities. -├── lib: Core libraries for various protocol functionalities. -│ ├── cchain: Consensus chain interaction utilities. -│ └── xchain: Cross-chain messaging and utilities. -├── octane: Octane is a modular framework for the EVM. -│ └── evmengine: The EVMEngine cosmos module. +├── docs: Resources and website for https://docs.omni.network. +├── e2e: Deployments, testing, and live network management. +├── halo: Omni consensus client. +├── lib: Core libraries used across the Omni stack. +├── monitor: Monitoring service for the network. +├── octane: Cosmos SDK module for the EVM. ├── relayer: Relayer service for cross-chain messages and transactions. -│ └── app: Application logic for the relayer service. ├── scripts: Utility scripts for development and operational tasks. -└── test: Testing suite for end-to-end, smoke, and utility testing. +├── sdk: SDK for building applications with Omni. +├── solver: Reference implementation for SolverNet.## Contributing