arnaucube
/
miden-crypto
mirror of https://github.com/arnaucube/miden-crypto.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
343 Commits
7 Branches
24 Tags
100 MiB
 
 
 
Tree: 03639148d7
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '03639148d7'
${ noResults }
miden-crypto/docs
kmurphypolygon d8cf98a0b5
commit skeleton docs site 		1 year ago
..
README.md commit skeleton docs site 1 year ago
digital-signatures.md commit skeleton docs site 1 year ago
hash-functions.md commit skeleton docs site 1 year ago
merkle-structures.md commit skeleton docs site 1 year ago
welcome.md commit skeleton docs site 1 year ago

README.md

Miden base documentation

Welcome to the Miden client repo docs.

Running locally

Prerequisites

  1. Python 3.12.
  2. 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
./run.sh

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

Style guide

We are using the Microsoft Style Guide.

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.