Skip to content

Latest commit

 

History

History
30 lines (22 loc) · 1.21 KB

README.md

File metadata and controls

30 lines (22 loc) · 1.21 KB

Clarity Book

Clarity of Mind is both an introductory as well as a reference book for the Clarity smart contract language. Clarity is developed as a joint effort of Hiro PBC, Algorand, and various other stakeholders, that originally targets the Stacks blockchain. A significant innovation in the field of smart contract development, Clarity allows you to write more safe and secure smart contracts. The language optimises for readability and predictability and is purpose-built for developers working applications with high-stakes transactions.

The book is free and open source, written in Markdown files. You can clone this repository and build a HTML version of the book. Different build scripts are expected to be added in the future. (PDF, ePub, and so on.)

The book can be accessed online here: http://book.clarity-lang.org.

Building

  • Clone this repository.
  • npm install to install build dependencies.
  • npm run build will output a HTML version to the build folder.

You may use npm run dev to run a local instance that triggers a rebuild when it detects a file change.

License

Creative Commons Attribution Share Alike 4.0 International. Any code is licensed under MIT.