mirror of
https://github.com/ProvableHQ/leo.git
synced 2024-12-25 11:12:48 +03:00
Merge pull request #517 from AleoHQ/feat/readme
Update Leo package README with a simple build guide
This commit is contained in:
commit
5a0c924c05
5
package/README.md
Normal file
5
package/README.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
# leo-package
|
||||||
|
|
||||||
|
This module defines the structure of a Leo project package.
|
||||||
|
|
||||||
|
Each file in this directory mirrors a corresponding file generated in a new Leo project package.
|
@ -58,6 +58,29 @@ impl README {
|
|||||||
}
|
}
|
||||||
|
|
||||||
fn template(&self) -> String {
|
fn template(&self) -> String {
|
||||||
format!("# {}\n", self.package_name)
|
format!(
|
||||||
|
r"# {}
|
||||||
|
|
||||||
|
## Build Guide
|
||||||
|
|
||||||
|
To compile this Leo program, run:
|
||||||
|
```
|
||||||
|
leo build
|
||||||
|
```
|
||||||
|
|
||||||
|
To test this Leo program, run:
|
||||||
|
```
|
||||||
|
leo test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
To output the number of constraints, run:
|
||||||
|
```
|
||||||
|
leo build -d
|
||||||
|
```
|
||||||
|
",
|
||||||
|
self.package_name
|
||||||
|
)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
Loading…
Reference in New Issue
Block a user