diff --git a/README.md b/README.md new file mode 100644 index 0000000..dd2a505 --- /dev/null +++ b/README.md @@ -0,0 +1,16 @@ +# Bauke 🦖 XYZ + +> **Bauke's website.** + +## Development + +Requires working installations of [Rust and Cargo](https://www.rust-lang.org/learn/get-started), [NodeJS](https://nodejs.org) and [pnpm](https://pnpm.io). + +* Install the dependencies with `pnpm install`. +* Build the website with `cargo run`. +* Deploy to Netlify with `pnpm deploy`. +* Test the code with `pnpm test`. + +## License + +Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Bauke/bauke-xyz/src/branch/main/LICENSE) for more information.