Updated the README.md
This commit is contained in:
23
README.md
23
README.md
@@ -10,3 +10,26 @@
|
|||||||
[](https://github.com/little-emulator)
|
[](https://github.com/little-emulator)
|
||||||
|
|
||||||
</div><br>
|
</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
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user