Skip to content

Commit 74d949b

Browse files
authored
Update README.md
style updates for italics usage & bulleted lists
1 parent ddbbb80 commit 74d949b

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

README.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,57 +2,57 @@
22

33
![Mastering Cardano Cover](images/cover.png)
44

5-
**"Mastering Cardano" is now available from [Book.io](https://book.io/)! [Purchase your copy here (coming soon!)](https://www.google.com/search?q=https://book.io/placeholder-for-mastering-cardano).**
5+
**Mastering Cardano is now available from [Book.io](https://book.io/)! [Purchase your copy here (coming soon!)](https://www.google.com/search?q=https://book.io/placeholder-for-mastering-cardano).**
66

7-
Welcome to **Mastering Cardano**, a comprehensive, open-source book dedicated to exploring the depths of the Cardano blockchain. This book is a collaborative effort, written by experts and the community, for anyone interested in understanding, building on, or participating in the Cardano ecosystem.
7+
Welcome to _Mastering Cardano_, a comprehensive, open-source book dedicated to exploring the depths of the Cardano blockchain. This book is a collaborative effort, written by experts and the community, for anyone interested in understanding, building on, or participating in the Cardano ecosystem.
88

9-
"Mastering Cardano" is a living document, intended to evolve with the Cardano platform. We invite you, the reader, to join us in this journey of learning and contribution.
9+
_Mastering Cardano_ is a living document, intended to evolve with the Cardano platform. We invite you, the reader, to join us in this journey of learning and contribution.
1010

1111
## **About the Book**
1212

13-
"Mastering Cardano" provides a thorough exploration of the Cardano blockchain, from its foundational principles to the intricacies of smart contract development and decentralized governance. The book is structured to cater to a wide audience, including developers, stake pool operators, students, and enthusiasts.
13+
_Mastering Cardano_ provides a thorough exploration of the Cardano blockchain, from its foundational principles to the intricacies of smart contract development and decentralized governance. The book is structured to cater to a wide audience, including developers, stake pool operators, students, and enthusiasts.
1414

1515
### **Table of contents**
1616

17-
1. **Introduction**: A primer on blockchain technology, smart contracts, and the foundational concepts of Cardano.
18-
2. **Cryptography**: An overview of the cryptographic principles that secure the Cardano network.
19-
3. **Learn about Cardano**: A deep dive into the history, core principles, and ecosystem of Cardano.
20-
4. **How Cardano Works**: Detailed explanations of the Cardano node, the EUTXO model, Ouroboros consensus, and native assets.
21-
5. **Cardano Governance**: An exploration of Cardano's decentralized governance model, including CIPs, Project Catalyst, and the Age of Voltaire.
22-
6. **Cardano Digital Wallets**: A guide to using and understanding digital wallets within the Cardano ecosystem.
23-
7. **Stake Pools and Stake Pool Operation**: A comprehensive guide for aspiring and current stake pool operators.
24-
8. **Writing Smart Contracts**: A practical guide to developing smart contracts on Cardano using Plutus and Marlowe.
25-
9. **Decentralized Applications (DApps)**: An introduction to building and interacting with DApps on Cardano.
26-
10. **Looking Forward**: A glimpse into the future of Cardano, including scaling solutions like Hydra and Mithril.
17+
1. _Introduction_ — a primer on blockchain technology, smart contracts, and the foundational concepts of Cardano.
18+
2. _Cryptography_ — an overview of the cryptographic principles that secure the Cardano network.
19+
3. _Learn about Cardano_ — a deep dive into the history, core principles, and ecosystem of Cardano.
20+
4. _How Cardano works_ — detailed explanations of the Cardano node, the EUTXO model, Ouroboros consensus, and native assets.
21+
5. _Cardano governance_ — an exploration of Cardano's decentralized governance model, including CIPs, Project Catalyst, and the Age of Voltaire.
22+
6. _Cardano digital wallets_ — a guide to using and understanding digital wallets within the Cardano ecosystem.
23+
7. _Stake pools and stake pool operation_ — a comprehensive guide for aspiring and current stake pool operators.
24+
8. _Writing smart contracts_ — a practical guide to developing smart contracts on Cardano using Plutus and Marlowe.
25+
9. _Decentralized applications (DApps)_ — an introduction to building and interacting with DApps on Cardano.
26+
10. _Looking forward_ — a glimpse into the future of Cardano, including scaling solutions like Hydra and Mithril.
2727

2828
## **How to use this book**
2929

30-
"Mastering Cardano" is designed to be flexible. You can read it from start to finish or follow one of the suggested reading paths tailored to your interests:
30+
_Mastering Cardano_ is designed to be flexible. You can read it from start to finish or follow one of the suggested reading paths tailored to your interests:
3131

32-
* **Cardano Fundamentals Path**: For beginners who want a solid understanding of blockchain and Cardano.
33-
* **Smart Contracts Developer Path**: For developers looking to build smart contracts and DApps on Cardano.
34-
* **Cardano User Path**: For non-technical users who want to learn how to use and interact with the Cardano ecosystem.
35-
* **Stake Pool Operator Path**: For those interested in running and maintaining a stake pool.
36-
* **Cardano Governance and Future Path**: For readers interested in the long-term vision and governance of Cardano.
32+
* _Cardano fundamentals path_ — for beginners who want a solid understanding of blockchain and Cardano.
33+
* _Smart contracts developer path_ — for developers looking to build smart contracts and DApps on Cardano.
34+
* _Cardano user path_ — for non-technical users who want to learn how to use and interact with the Cardano ecosystem.
35+
* _Stake pool operator path_ — for those interested in running and maintaining a stake pool.
36+
* _Cardano governance and future path_ — for readers interested in the long-term vision and governance of Cardano.
3737

3838
## **Building the book**
3939

4040
This book is written in AsciiDoc. To build your own PDF and EPUB versions from the source, please follow these steps.
4141

4242
### **Prerequisites**
4343

44-
* **Ruby and Bundler**: The build process relies on Ruby and Bundler. Please ensure you have a recent version of Ruby installed.
45-
* **Graphviz**: Required for rendering diagrams in the book.
44+
* _Ruby and Bundler_ — the build process relies on Ruby and Bundler. Please ensure you have a recent version of Ruby installed.
45+
* _Graphviz_ — required for rendering diagrams in the book.
4646

4747
### **Build instructions**
4848

49-
1. **Clone the repository**:
49+
1. Clone the repository, as follows:
5050
```
5151
git clone https://github.com/input-output-hk/mastering-cardano.git
5252
cd mastering-cardano
5353
```
5454

55-
2. Install Dependencies:
55+
2. Install dependencies, as follows:
5656
This project uses Bundler to manage Ruby gems. Install the required gems with:
5757
```
5858
bundle install
@@ -64,7 +64,7 @@ This book is written in AsciiDoc. To build your own PDF and EPUB versions from t
6464
sudo apt-get update && sudo apt-get install -y graphviz
6565
```
6666

67-
4. Build the Book:
67+
4. Build the book:
6868
You can build both the PDF and EPUB versions using the Makefile: `make`
6969

7070
Alternatively, you can build each format individually:
@@ -75,12 +75,12 @@ The generated files will be placed in the `dist/` directory.
7575

7676
## **Contributing**
7777

78-
"Mastering Cardano" is a community-driven project, and we welcome contributions of all kinds. Whether you're fixing a typo, clarifying a concept, or adding new content, your input is valuable.
78+
_Mastering Cardano_ is a community-driven project, and we welcome contributions of all kinds. Whether you're fixing a typo, clarifying a concept, or adding new content, your input is valuable.
7979

8080
To contribute, please fork the repository and submit a pull request with your proposed changes. For more significant changes, we recommend opening an issue first to discuss your ideas with the community.
8181

8282
## **About the authors**
8383

84-
"Mastering Cardano" is authored by **Dr. Lars Brünjes**, Director of Education at IO, and **Prof. Joshua Ellul**, Director of the Centre for DLT at the University of Malta, with contributions from numerous experts and community members. This book is a testament to the collaborative and open-source spirit of the Cardano ecosystem.
84+
_Mastering Cardano_ is authored by _Dr. Lars Brünjes_, Director of Education at IO, and _Prof. Joshua Ellul_, Director of the Centre for DLT at the University of Malta, with contributions from numerous experts and community members. This book is a testament to the collaborative and open-source spirit of the Cardano ecosystem.
8585

86-
We hope you enjoy reading "Mastering Cardano" and find it a valuable resource on your journey into the world of blockchain. Happy reading\!
86+
We hope you enjoy reading _Mastering Cardano_ and find it a valuable resource on your journey into the world of blockchain. Happy reading!

0 commit comments

Comments
 (0)