From 6ba526a88cc6e46dc2976f1335e70a0144f45d2d Mon Sep 17 00:00:00 2001 From: Zijian Zhang Date: Sat, 25 Nov 2023 09:22:50 +0800 Subject: [PATCH] docs: update readme --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index c871c98..38aa702 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,21 @@ A LeviLamina plugin template This plugin is a template for developing LeviLamina plugins. -## Install +## Usage -Before installing this plugin, make sure that you have installed XMake and a Minecraft Bedrock Server with LeviLamina. +Before using this plugin template, make sure that you have installed XMake and a Minecraft Bedrock Server with LeviLamina. 1. Generate a new repository from this template. 1. Clone the new repository into a local folder. -1. Run `xmake` in the root of the repository. +1. Change the plugin name in `xmake.lua`. -1. Copy all files from `bin/` to `plugins/` in the Minecraft Bedrock Server folder. +1. Add your code. -## Usage +1. Run `xmake` in the root of the repository. -Run the Minecraft Bedrock Server with LeviLamina. +Now the build is complete at `bin/`. ## Contributing