Skip to content

Latest commit

 

History

History
29 lines (20 loc) · 848 Bytes

README.md

File metadata and controls

29 lines (20 loc) · 848 Bytes

Linera Developer Documentation

Repository for the developer documentation of Linera hosted on https://linera.dev

Initialize git submodules

git submodule update --init

To discard local changes to the submodule (the equivalent of git checkout -f HEAD for files), use git submodule update. To commit local changes, use git commit -a as usual.

NOTE: It is expected that the HEAD of linera-protocol is always set to be a given commit hash (as opposed to a branch name).

Browse the developer docs locally (including local changes)

cargo install mdbook
mdbook serve

Then, open the URL as instructed.

Formatting

This repository is formatted with prettier. To install prettier run npm install -g prettier. To use prettier run prettier --write src/. The repository is automatically checked for formatting in CI.