Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance README: Improved badges, layout, and styling #7318

Closed
wants to merge 1 commit into from
Closed

Enhance README: Improved badges, layout, and styling #7318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 78 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,48 +3,102 @@
<img src="./noir-logo.png" alt="The Noir Programming Language" width="35%">
</picture>

[Website][Noir] | [Getting started] | [Documentation] | [Contributing]
<br/>
<p align="center">
<a href="https://www.noir-lang.org">
<img src="https://img.shields.io/badge/Website-0077b5?logo=internet-explorer&logoColor=white" alt="Website">
</a>
<a href="https://noir-lang.org/docs/getting_started/quick_start/">
<img src="https://img.shields.io/badge/Getting%20Started-4CAF50?logo=read-the-docs&logoColor=white" alt="Getting Started">
</a>
<a href="https://noir-lang.org/docs">
<img src="https://img.shields.io/badge/Documentation-FFA500?logo=bookstack&logoColor=white" alt="Documentation">
</a>
<a href="CONTRIBUTING.md">
<img src="https://img.shields.io/badge/Contributing-6e5494?logo=github&logoColor=white" alt="Contributing">
</a>

<a href="https://forum.aztec.network/c/noir">
<img src="https://img.shields.io/badge/Forum-8E44AD?logo=discourse&logoColor=white" alt="Forum">
</a>
<a href="https://discord.gg/JtqzkdeQ6G">
<img src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white" alt="Discord">
</a>
</p>


</div>

---

# 🖤 The Noir Programming Language

Noir is a **Domain Specific Language for SNARK proving systems**.
It is designed to be **compatible with any ACIR proving system**.

⚠️ **Early Development Notice:**
This implementation is in **alpha stage**, has not been reviewed/audited, and is **not production-ready**.
Expect bugs and breaking changes!

---

## 🚀 Quick Start

📌 **Read the [installation guide](https://noir-lang.org/docs/getting_started/quick_start/) from the Noir documentation.**

💡 Once you've explored the documentation, check out [Awesome Noir](https://github.com/noir-lang/awesome-noir)
for community-driven examples and projects.

---

# The Noir Programming Language
## 🤝 Getting Help

Noir is a Domain Specific Language for SNARK proving systems. It has been designed to use any ACIR compatible proving system.
💬 **[Join the Noir Forum](https://forum.aztec.network/c/noir)**
🎮 **[Join the Noir Discord](https://discord.gg/JtqzkdeQ6G)**

**This implementation is in early development. It has not been reviewed or audited. It is not suitable to be used in production. Expect bugs!**
---

## Quick Start
## 🛠️ Contributing

Read the [installation section][Getting started] from the [Noir docs][Documentation].
We welcome contributions!
See **[CONTRIBUTING.md](CONTRIBUTING.md)** for guidelines.

Once you have read through the documentation, you can visit [Awesome Noir](https://github.com/noir-lang/awesome-noir) to run some of the examples that others have created.
---

## Getting Help
## 🔮 Future Work

Join the Noir [forum][Forum] or [Discord][Discord]
Noir is in its **alpha phase**, and we're actively gathering feedback.
The **primary goals** are **_safety_** and **_developer experience_**.

## Contributing
📌 **If you find anything that doesn't align with these goals, [open an issue](https://github.com/noir-lang/noir/issues)!**

See [CONTRIBUTING.md][CONTRIBUTING].
---

## Future Work
## 🦀 Minimum Rust Version

The current focus is to gather as much feedback as possible while in the alpha phase. The main focuses of Noir are _safety_ and _developer experience_. If you find a feature that does not seem to be in line with these goals, please open an issue!
📌 **Rust 1.75.0 or newer is required** for this workspace.

## Minimum Rust version
---

This workspace's minimum supported rustc version is 1.75.0.
## 📜 License

## License
Noir is **free and open-source**, distributed under a **dual MIT/APACHE license**.

Noir is free and open source. It is distributed under a dual license. (MIT/APACHE)
🚀 Any contributions are **automatically dual-licensed** as per the Apache-2.0 license.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this repository by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
---

[Noir]: https://www.noir-lang.org/
[Getting Started]: https://noir-lang.org/docs/getting_started/quick_start/
[Forum]: https://forum.aztec.network/c/noir
[Discord]: https://discord.gg/JtqzkdeQ6G
[Documentation]: https://noir-lang.org/docs
[Contributing]: CONTRIBUTING.md
<p align="left">
<a href="https://www.noir-lang.org">
<img src="https://img.shields.io/badge/Website-0077b5?logo=internet-explorer&logoColor=white&style=for-the-badge" alt="Website">
</a>
<a href="https://noir-lang.org/docs">
<img src="https://img.shields.io/badge/Docs-4CAF50?logo=read-the-docs&logoColor=white&style=for-the-badge" alt="Docs">
</a>
<a href="https://github.com/noir-lang/noir">
<img src="https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white&style=for-the-badge" alt="GitHub">
</a>
<a href="https://discord.gg/JtqzkdeQ6G">
<img src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white&style=for-the-badge" alt="Discord">
</a>
</p>
Loading