https://github.com/mimblewimble/docs

Documentation for Grin and Mimblewimble
https://github.com/mimblewimble/docs

documentation grin mimblewimble

Last synced: 2 months ago
JSON representation

Documentation for Grin and Mimblewimble

• Host: GitHub
• URL: https://github.com/mimblewimble/docs
• Owner: mimblewimble
• Created: 2017-12-19T23:40:06.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-05T13:17:06.000Z (about 1 year ago)
• Last Synced: 2024-05-22T19:30:19.291Z (about 1 year ago)
• Topics: documentation, grin, mimblewimble
• Language: HTML
• Homepage: https://docs.grin.mw
• Size: 5.6 MB
• Stars: 305
• Watchers: 52
• Forks: 87
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Grin Documentation

## Requirements

Clone repo and navigate to directory:

```bash

git clone --recursive https://github.com/mimblewimble/docs.git

```

### Local

Install the following software:

- [MkDocs](https://www.mkdocs.org/#installation)

- [MkDocs Material theme](https://squidfunk.github.io/mkdocs-material/getting-started/)

Then start the local Mkdocs server:

```bash

mkdocs serve

```

### Container

Start the local MkDocs server:

```bash

docker build -t docs -f Containerfile .

docker run -p 8000:8000 -v ./:/app/:ro docs:latest

```

## Test

Visit `http://localhost:8000` to see live changes.

When ready, push changes to your forked repo and then submit a PR.