Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Line Edits for README.md #150

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Irmin website    [![OCaml-CI status][ocaml-ci-img]][ocaml-ci]
# Irmin Website    [![OCaml-CI status][ocaml-ci-img]][ocaml-ci]

[ocaml-ci]: https://ocaml.ci.dev/github/mirage/irmin.org
[ocaml-ci-img]: https://img.shields.io/endpoint?url=https%3A%2F%2Focaml.ci.dev%2Fbadge%2Fmirage%2Firmin.org%2Fmain&logo=ocaml
Expand All @@ -10,7 +10,7 @@ distributed database][irmin] and contains tutorials for getting started with Irm

All contributions are welcome! The tutorial files can be found in [`data/tutorial`][tutorial-dir].

### Building the website locally
### Building the Website Locally

The minimum version of Node required to build/run the site is 18. Packages are
managed with [`pnpm`][pnpm]. Since we use Node > 16, `corepack` is the recommended
Expand All @@ -32,7 +32,7 @@ pnpm serve # Serve the build at `localhost:9000`
When working on the website, an incremental development server can be run with `pnpm develop`,
but beware that this may show stale artefacts.

### Running tests/linting
### Running Tests/Linting

- The source code is formatted with [Prettier][prettier].
- Any incorrectly formatted code will be reported by `pnpm lint`.
Expand Down