README.md

2026-01-28 22:00:00 +03:00
parent b31b57878d
commit fa1dc503ab
1 changed files with 15 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,15 @@
+# Kurumi Bot
+
+## Building
+ - Linux
+   1. Run `make`
+ - Windows
+   1. Run `build.bat`
+
+## Development
+While development, if needed to change core code, clone dev branch [Laniakea](https://git.nix13.pw/ScuroNeko/Laniakea) inside root folder as `laniakea`.
+Uncomment `replace git.nix13.pw/scuroneko/laniakea v{VERSION} => ./laniakea`.
+
+You can build docker with custom core. Add `COPY ./laniakea ./laniakea` after `COPY ./utils ./utils` and before `COPY ./main.go ./`.
+
+To build with release core, remove rename from `go.mod`