diff --git a/README.md b/README.md index 60c8ec6..92bb7fc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ # Jankboard 2 - - +[![maintainability status](https://api.codeclimate.com/v1/badges/4bedd567dbf60ec87164/maintainability)](https://codeclimate.com/repos/65dfbdc904f9ed00bbf381c8/maintainability) A remastered version of the original Jankboard, with a focus on minimizing the Jank portion. Designed from the ground up to be easy to maintain and extend, unlike the original. The frontend is powered by Svelte 4 (unfortunately, we had to drop support for the bleeding edge Svelte 5 due to lack of Vite support). @@ -15,7 +14,7 @@ We recommend installing the latest stable release binaries from [our release pag If you would like to contribute to Jankboard 2, there's only a few simple steps to get the development build up and running. -**Prerequisites** +### Prerequisites - Rust and `cargo`. Check the [Rust docs](https://www.rust-lang.org/learn) for more information. We recommend you install Rust using `rustup`. Keep in mind that this is ONLY necessary for development, release binaries do not require Rust. - NodeJS and `npm`, for installing dependencies and the `vite` development server.