little-emulator/docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated the README.md

Browse Source
This commit is contained in:
Nicola Belluti
2025-10-29 12:43:15 +01:00
parent 1e79365a67
commit 67326a3784
1 changed files with 23 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@@ -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)
</div><br>
> 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
```