# Miden base documentation

Welcome to the Miden client repo docs.

## Running locally

### Prerequisites

1. [Python 3.12](https://www.python.org/downloads/).
2. [`virtualenv`](https://pypi.org/project/virtualenv/): Install using `pip3 install virtualenv`.

### Setup

1. Clone the repository.
2. `cd` to the root.
3. Run the `run.sh` script. You may need to make the script executable: `chmod +x run.sh`

```sh
./run.sh
```

The site comes up at http://127.0.0.1:8000/ 

## Style guide

We are using the [Microsoft Style Guide](https://learn.microsoft.com/en-us/style-guide/welcome/).

## Contributing

1. Fork the `main` branch into your own GitHub account and create a feature branch for your changes.
2. Commit changes and create a PR.

## Contact

- For docs issues (technical or language) open an issue here.
- For anything else, join our [Discord](https://discord.gg/0xpolygondevs).