From 26890ff09724163d0f52bb4c360d7ee210a24c6b Mon Sep 17 00:00:00 2001 From: collin Date: Mon, 29 Jun 2020 19:36:30 -0700 Subject: [PATCH] update readme --- README.md | 27 ++++++++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 60f7c5d741..8fcbe7ff56 100644 --- a/README.md +++ b/README.md @@ -561,13 +561,28 @@ This will create a new directory with a given package name. The new package will - inputs.leo # Your program inputs for main.leo - outputs # Your program outputs - src - - lib.leo # Your program library - main.leo # Your program - tests - test.leo # Your program tests - Leo.toml # Your program manifest ``` +#### Flags +```rust +leo new {$Name} --bin +``` +This will create a new directory with a given package name. The new package will have a directory structure as above. + +```rust +leo new {$Name} --lib +``` +This will create a new directory with a given package name. The new package will have a directory structure as follows: +``` +- src + - lib.leo # Your program library +- Leo.toml # Your program manifest +``` + ### `leo init` To initialize an existing directory, run: @@ -576,6 +591,16 @@ leo init ``` This will initialize the current directory with the same package directory setup. +#### Flags +`leo init` supports the same flags as `leo new` +```rust +leo init --bin +``` +```rust +leo init --lib +``` + + ### `leo build` To compile your program and verify that it builds properly, run: