From a0a2c78005e0008817afa5d48e7eb4a1c74c8d83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Dos=20Santos?= <31006039+aureliendossantos@users.noreply.github.com> Date: Sat, 24 Jan 2026 20:05:46 +0100 Subject: [PATCH 1/3] docs: expand readme with a quick start --- README.md | 51 +++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 47 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 68294ef9..0fa4bcf8 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,58 @@ [![CodSpeed Badge](https://img.shields.io/endpoint?url=https://codspeed.io/badge.json)](https://codspeed.io/bruits/maudit) [![Discord](https://img.shields.io/discord/1323452220817014876)](https://maudit.org/chat/) -A library for generating static websites with Rust. +[Maudit](https://maudit.org) is a library for generating static websites with Rust. + +## Install + +The quickest way to get started is with the Maudit CLI. + +First, you will need to install Rust 1.89 or later. We recommend using [rustup](https://rustup.rs/). + +Then, install the Maudit CLI tool with: + +```bash +cargo install maudit-cli +``` + +You can now create a new project by running the following command: + +```bash +maudit init +``` + +Maudit will ask you a series of questions and generate the project. Once it's done, navigate to the new directory and start the development server: + +```bash +cd my-website +maudit dev +``` + +The first build downloads and compiles dependencies, which will take some time. Subsequent builds will be much faster. + +If you wish to use Maudit without the CLI tool, or to integrate Maudit into an existing project, please refer to the [manual installation guide](/docs/manual-install). + +## Build + +Build your project to the `dist` directory with optimizations suited for production: + +```bash +maudit build +``` + +Preview your build on a local server before deploying: + +```bash +maudit preview +``` ## Quick links -🌍 Visit our [website](https://maudit.org) to read the [documentation](https://maudit.org/docs) and our [news](https://maudit.org/news) +🌍 Visit our [website](https://maudit.org) to read the [documentation](https://maudit.org/docs) and the latest [news](https://maudit.org/news) 📦 See the [crate](https://crates.io/crates/maudit) on Crates.io, and the [reference](https://docs.rs/maudit/latest/maudit/) on Docs.rs. -🐛 [Report a bug](https://github.com/bruits/maudit/issues), please read our [contributing guidelines](https://github.com/bruits/maudit/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/bruits/maudit/blob/main/CODE_OF_CONDUCT.md) first. +🐛 [Report a bug](https://github.com/bruits/maudit/issues). Please read our [contributing guidelines](https://github.com/bruits/maudit/blob/main/CONTRIBUTING.md) and [code of conduct](https://github.com/bruits/maudit/blob/main/CODE_OF_CONDUCT.md) first. 💬 Join the discussion on [Github](https://github.com/bruits/maudit/discussions) and [Discord](https://maudit.org/chat/), if you have any questions, ideas, or suggestions. @@ -27,4 +70,4 @@ Contributions are welcome! See our [Contributor Guide](https://github.com/bruits # License -Maudit is licensed under [the MIT License](https://opensource.org/license/MIT). See [LICENSE](LICENSE) for details. +Maudit is licensed under the [MIT License](https://opensource.org/license/MIT). See [LICENSE](LICENSE) for details. From bcede23cf935c75a8d8b2933505b2f1779af9eb4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Dos=20Santos?= <31006039+aureliendossantos@users.noreply.github.com> Date: Sat, 24 Jan 2026 20:27:38 +0100 Subject: [PATCH 2/3] docs: simplified readme --- README.md | 27 ++++++++++----------------- 1 file changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 0fa4bcf8..2216f972 100644 --- a/README.md +++ b/README.md @@ -11,44 +11,37 @@ [Maudit](https://maudit.org) is a library for generating static websites with Rust. -## Install +## Getting started -The quickest way to get started is with the Maudit CLI. - -First, you will need to install Rust 1.89 or later. We recommend using [rustup](https://rustup.rs/). - -Then, install the Maudit CLI tool with: +The quickest way to get started is with the Maudit CLI: ```bash cargo install maudit-cli ``` -You can now create a new project by running the following command: +Create a new project by running: ```bash maudit init ``` -Maudit will ask you a series of questions and generate the project. Once it's done, navigate to the new directory and start the development server: +You can also use Maudit without the CLI tool, or integrate Maudit into an existing project. Check out our [Manual Installation](/docs/manual-install) guide. + +## Development + +Start a local server with live reloading: ```bash -cd my-website maudit dev ``` -The first build downloads and compiles dependencies, which will take some time. Subsequent builds will be much faster. - -If you wish to use Maudit without the CLI tool, or to integrate Maudit into an existing project, please refer to the [manual installation guide](/docs/manual-install). - -## Build - -Build your project to the `dist` directory with optimizations suited for production: +Build your project to the `dist` directory: ```bash maudit build ``` -Preview your build on a local server before deploying: +Preview your build before deploying: ```bash maudit preview From fa70d20c60a31a0ed5d86f822c382a769d40328a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Aur=C3=A9lien=20Dos=20Santos?= <31006039+aureliendossantos@users.noreply.github.com> Date: Sat, 24 Jan 2026 21:02:01 +0100 Subject: [PATCH 3/3] docs: fix readme wording --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2216f972..0449fcfa 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,9 @@ maudit init You can also use Maudit without the CLI tool, or integrate Maudit into an existing project. Check out our [Manual Installation](/docs/manual-install) guide. -## Development +## Commands -Start a local server with live reloading: +Start a local dev server with live reload: ```bash maudit dev @@ -61,6 +61,6 @@ maudit preview Contributions are welcome! See our [Contributor Guide](https://github.com/bruits/maudit/blob/main/CONTRIBUTING.md) for help getting started. -# License +## License Maudit is licensed under the [MIT License](https://opensource.org/license/MIT). See [LICENSE](LICENSE) for details.