From c85c117dcff7cd796984e519d7666e0f26aed469 Mon Sep 17 00:00:00 2001 From: Guillaume Bouvignies Date: Thu, 4 Jul 2024 16:37:58 +0200 Subject: [PATCH] Update README and book --- README.md | 1 + docs/src/SUMMARY.md | 1 + docs/src/commands/buffrs-new.md | 21 +++++++++++++++++++++ 3 files changed, 23 insertions(+) create mode 100644 docs/src/commands/buffrs-new.md diff --git a/README.md b/README.md index e1dc2cd8..d5066855 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,7 @@ Usage: buffrs Commands: init Initializes a buffrs setup + new Creates a new buffrs package in the current directory lint Check rule violations for this package add Adds dependencies to a manifest file remove Removes dependencies from a manifest file diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 0bfca219..f6668084 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -76,6 +76,7 @@ * [buffrs update]() * [Package Commands](commands/package-commands.md) * [buffrs init](commands/buffrs-init.md) + * [buffrs new](commands/buffrs-new.md) * [buffrs lint](commands/buffrs-lint.md) * [buffrs package](commands/buffrs-package.md) * [buffrs install](commands/buffrs-install.md) diff --git a/docs/src/commands/buffrs-new.md b/docs/src/commands/buffrs-new.md new file mode 100644 index 00000000..db26bfff --- /dev/null +++ b/docs/src/commands/buffrs-new.md @@ -0,0 +1,21 @@ +## buffrs init + +Initializes a Buffrs project in a new folder created in the current directory. + +### Synopsis + +`buffrs new ` + +`buffrs new --lib ` + +`buffrs new --api ` + +### Description + +This command creates a new Buffrs project with the provided name by creating a +manifest file (`Proto.toml`) as well as `proto` and `proto/vendor` directories +in a new directory created at the current location. + +By default, if no package type is provided, `impl` (implementation) will be +used. The meaning of this is described in [Package +Types](../guide/package-types.md).