From 7b9f29d8b93d3dd2ddd9bfff88a676965599282e Mon Sep 17 00:00:00 2001 From: microwavedcola1 Date: Fri, 21 Jan 2022 19:30:28 +0100 Subject: [PATCH] readme Signed-off-by: microwavedcola1 --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a7e3659d5..015da88a9 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ -Development +### Development * rustc 1.57.0 (f1edd0429 2021-11-29) * anchor-cli 0.20.1 * npm 8.1.2 -* node v16.13.1 \ No newline at end of file +* node v16.13.1 + +### Module structure +As and when we move to a more complete project, we should think of having multiple modules +e.g. core/shared, spot, perpetuals, etc., and then each would have its own instructions and state sub module +``` +programs +└── mango-v4 + ├── Cargo.toml + ├── Xargo.toml + └── src + │ ├── error.rs + │ ├── instructions # instructions go here, each instruction gets an individual file + │ │   ├── initialiaze.rs + │ │   └── mod.rs + │ ├── lib.rs + │ └── state # state goes here, each account state gets an individual file + │ └── mod.rs + └── tests # rust tests, TODO +``` +