Skip to content

Commit e99d4f9

Browse files
committed
docs: update readme
1 parent 439ed48 commit e99d4f9

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,34 @@
11
# Cairo Bootcamp 5.0
22
This repository contains all the codes for Cairo Bootcamp 5.0
3+
4+
## Set up instructions
5+
To set up this repository, you will need to install [Starkup](https://github.com/software-mansion/starkup).
6+
7+
StarkUp installs and setup the following packages in your machine:
8+
- Scarb - the Cairo package manager
9+
- Starknet Foundry - the Cairo and Starknet testing framework
10+
- Universal Sierra Compiler - compiler for any ever-existing Sierra version
11+
- Cairo Profiler - profiler for Cairo programming language & Starknet
12+
- Cairo Coverage - utility for coverage reports generation for code written in Cairo programming language
13+
- CairoLS - vscode extension
14+
15+
16+
Run the following command to install StarkUp:
17+
```bash
18+
curl --proto '=https' --tlsv1.2 -sSf https://sh.starkup.sh | sh
19+
```
20+
21+
## Build and Test Contracts
22+
To build and test the contracts, run the following commands
23+
24+
**Build contracts**
25+
```bash
26+
scarb build
27+
```
28+
29+
**Run contract tests**
30+
```bash
31+
scarb run test
32+
```
33+
34+
> `scarb run test` runs `snforge test` under the hood. So you can optionally use `snforge test` to test the contracts

0 commit comments

Comments
 (0)