diff --git a/package/README.md b/package/README.md new file mode 100644 index 0000000000..c1fbeead31 --- /dev/null +++ b/package/README.md @@ -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. diff --git a/package/src/root/readme.rs b/package/src/root/readme.rs index d06c6b3fe9..3b94db1008 100644 --- a/package/src/root/readme.rs +++ b/package/src/root/readme.rs @@ -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 + ) } }