Merge pull request #517 from AleoHQ/feat/readme

Update Leo package README with a simple build guide
This commit is contained in:
Howard Wu 2021-01-02 18:17:01 -04:00 committed by GitHub
commit 5a0c924c05
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 29 additions and 1 deletions

5
package/README.md Normal file
View 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.

View File

@ -58,6 +58,29 @@ impl README {
}
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
)
}
}