Skip to content

Commit 0ad2afe

Browse files
fixed readme
1 parent 9a90cc6 commit 0ad2afe

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed
Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
1-
# TransferSol
1+
# Transfer Sol
22

3-
**TransferSol** is a ...
4-
5-
## API
6-
- [`Consts`](api/src/consts.rs) – Program constants.
7-
- [`Error`](api/src/error.rs) – Custom program errors.
8-
- [`Event`](api/src/event.rs) – Custom program events.
9-
- [`Instruction`](api/src/instruction.rs) – Declared instructions.
3+
Simple example of a Solana program that transfers SOL between accounts.
104

11-
## Instructions
12-
- [`Hello`](program/src/hello.rs) – Hello ...
5+
For more information, see this [README](../README.md).
136

14-
## State
15-
- [`User`](api/src/state/user.rs) – User ...
7+
## Building
168

17-
## Tests
9+
```sh
10+
cargo build-sbf
1811

19-
To run the test suit, use the Solana toolchain:
2012
```
21-
cargo test-sbf
13+
## Tests
14+
15+
This project includes both:
16+
- Rust tests: [`program/tests`](/program/tests) directory.
17+
- Node.js tests using [Bankrun](https://kevinheavey.github.io/solana-bankrun/): [`tests`](/tests) directory.
18+
19+
```sh
20+
# rust tests
21+
cargo test-sbf
22+
23+
# node tests
24+
pnpm build-and-test # this will also build the program
25+
#or
26+
pnpm test # if you have already built the program
2227
```

0 commit comments

Comments
 (0)