From b7617a1675e35126a939f495a9b99592c6c5184a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Moritz=20H=C3=B6lting?= <87192362+moritz-hoelting@users.noreply.github.com> Date: Fri, 29 Mar 2024 19:34:21 +0100 Subject: [PATCH] Add README.md file with instructions for using the Shulkerscript cli tool --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..bccef49 --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# Shulkerscript cli tool + +This is a cli tool for the shulkerscript language. It can be used to initialize a new project, and to compile and package a project. + +## Installation +```bash +cargo install --git https://github.com/moritz-hoelting/shulkerscript +``` + +## Usage + +### Initialize a new project +```bash +shulkerscript init [OPTIONS] [PATH] +``` +Where [PATH] is the path of the folder to initialize in [default: .] + +Options: +- `--name ` The name of the project +- `--description ` The description of the project +- `--pack-format ` The pack format version +- `--force` Force initialization even if the directory is not empty