From 67326a3784083a96e21a17e8286aff8b4bcd2400 Mon Sep 17 00:00:00 2001 From: Nicola Belluti Date: Wed, 29 Oct 2025 12:43:15 +0100 Subject: [PATCH] Updated the README.md --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 03440f9..de29643 100644 --- a/README.md +++ b/README.md @@ -10,3 +10,26 @@ [![GitHub Stars](https://img.shields.io/github/stars/little-emulator?style=flat&logo=github&label=GitHub%20Stargazers&cacheSeconds=3600)](https://github.com/little-emulator)
+ +> Some documentation for the [Little Emulator](https://little-emulator.org/) +> project, powered by [Hugo](https://gohugo.io/) and the +> [Hextra](https://imfing.github.io/hextra/) theme + +## Usage + +This project uses [Nix](https://nixos.org/) to create a reproducible development workspace + +```sh +# Clone the repository +git clone --recurse-submodules --shallow-submodules https://git.nicolabelluti.me/little-emulator/docs.git +cd docs + +# Enter the dev workspace +nix develop -c $SHELL + +# Build the website +make + +# Start the development webserver +make dev-server +```