From 08dcf793313be61da1b5ec0905e334d3a5d0cc89 Mon Sep 17 00:00:00 2001 From: Jesse Wierzbinski Date: Sat, 25 Nov 2023 13:39:54 -1000 Subject: [PATCH] Add README --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index e69de29..a5db534 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,12 @@ +# Lysand Docs + +## Contributing + +This site is built with [VitePress](https://github.com/vuejs/vitepress), and ite content is written in Markdown format located in `docs`. For simple edits, you can directly edit the file on GitHub and generate a Pull Request. + +For local development, [bun](https://bun.sh/) is preferred as package manager and runtime: + +```bash +bun i +bun docs:dev +``` \ No newline at end of file