Skip to content

Commit

Permalink
README.md is no longer a central landing page.
Browse files Browse the repository at this point in the history
  • Loading branch information
mikebenfield committed Feb 10, 2025
1 parent d578537 commit 8a47be5
Showing 1 changed file with 5 additions and 82 deletions.
87 changes: 5 additions & 82 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,91 +1,14 @@
<p align="center">
<img width="1412" src="./.resources/banner.png">
<a href="https://aleo.org"> <img alt="Website" src="https://img.shields.io/badge/Aleo.org-online-blue"></a>
<a href="https://discord.gg/aleo"><img src="https://img.shields.io/discord/700454073459015690?logo=discord"/></a>
<a href="https://twitter.com/AleoHQ"><img src="https://img.shields.io/twitter/follow/AleoHQ?style=social"/></a>
<a href="https://GitHub.com/AleoHQ/welcome"><img src="https://img.shields.io/badge/contributors-29-ee8449"/></a>
</p>
## Leo documentation

## 🎉 Welcome to Aleo.
This repository serves as a public source for documentation source files about the Aleo network and the Leo language
in particular. You can find them in readable form at [Developer Docs](https://docs.leo-lang.org/).
Other resources you may find helpful include

This repository serves as a guide for getting started with building on Aleo. Here is a quick summary of the key components:

- [📖 Aleo Developer Docs](https://docs.leo-lang.org/) - Developer documentation for Aleo and the Leo programming language.
- [📡 SnarkOS](http://snarkos.org/) - A decentralized operating system for private applications.
- [⚙️ SnarkVM](https://snarkvm.org/) - A virtual machine for zero-knowledge proofs.
- [🦁 Leo](https://leo-lang.org/) - A programming language for zero-knowledge proofs.
- [🛝 Leo Playground](http://play.leo-lang.org) - A browser interface to the Leo compiler for rapid ZK development and testing.
- [🧰 Aleo SDK](https://provable.tools/) - A Software Development Kit (SDK) for Zero-Knowledge Transactions.
- [🔭 Aleo Explorer](https://explorer.aleo.org) - Validate and broadcast on Aleo Testnet Beta

For help setting up, join us on [Discord](https://discord.com/invite/aleo) to ask questions and help others answer their questions.

We will be updating this page with FAQs to make it easy for finding common issues and to fix them quickly.

## ❤️ Contributors

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/howardwu"><img src="https://avatars.githubusercontent.com/u/9260812?v=4?s=100" width="100px;" alt="Howard Wu"/><br /><sub><b>Howard Wu</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=howardwu" title="Code">💻</a> <a href="#ideas-howardwu" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-howardwu" title="Maintenance">🚧</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Ahowardwu" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/collinc97"><img src="https://avatars.githubusercontent.com/u/16715212?v=4?s=100" width="100px;" alt="Collin Chin"/><br /><sub><b>Collin Chin</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=collinc97" title="Code">💻</a> <a href="#maintenance-collinc97" title="Maintenance">🚧</a> <a href="#question-collinc97" title="Answering Questions">💬</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Acollinc97" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/raychu86"><img src="https://avatars.githubusercontent.com/u/14917648?v=4?s=100" width="100px;" alt="Raymond Chu"/><br /><sub><b>Raymond Chu</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/issues?q=author%3Araychu86" title="Bug reports">🐛</a> <a href="https://github.com/AleoHQ/welcome/commits?author=raychu86" title="Code">💻</a> <a href="#ideas-raychu86" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Araychu86" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aharshbe"><img src="https://avatars.githubusercontent.com/u/17191728?v=4?s=100" width="100px;" alt="a h"/><br /><sub><b>a h</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=aharshbe" title="Documentation">📖</a> <a href="#maintenance-aharshbe" title="Maintenance">🚧</a> <a href="#projectManagement-aharshbe" title="Project Management">📆</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Aaharshbe" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/moAlobaidi"><img src="https://avatars.githubusercontent.com/u/37510951?v=4?s=100" width="100px;" alt="Mohammed Alobaidi"/><br /><sub><b>Mohammed Alobaidi</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=moAlobaidi" title="Code">💻</a> <a href="https://github.com/AleoHQ/welcome/commits?author=moAlobaidi" title="Documentation">📖</a> <a href="#maintenance-moAlobaidi" title="Maintenance">🚧</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3AmoAlobaidi" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/christianwooddell"><img src="https://avatars.githubusercontent.com/u/69871937?v=4?s=100" width="100px;" alt="Christian Wooddell"/><br /><sub><b>Christian Wooddell</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=christianwooddell" title="Code">💻</a> <a href="https://github.com/AleoHQ/welcome/commits?author=christianwooddell" title="Documentation">📖</a> <a href="#maintenance-christianwooddell" title="Maintenance">🚧</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Achristianwooddell" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://alessandrocoglio.info"><img src="https://avatars.githubusercontent.com/u/2409151?v=4?s=100" width="100px;" alt="Alessandro Coglio"/><br /><sub><b>Alessandro Coglio</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=acoglio" title="Documentation">📖</a> <a href="#maintenance-acoglio" title="Maintenance">🚧</a> <a href="#research-acoglio" title="Research">🔬</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Aacoglio" title="Reviewed Pull Requests">👀</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="http://www.kestrel.edu/home/people/mccarthy/"><img src="https://avatars.githubusercontent.com/u/7607035?v=4?s=100" width="100px;" alt="Eric McCarthy"/><br /><sub><b>Eric McCarthy</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=bendyarm" title="Documentation">📖</a> <a href="#maintenance-bendyarm" title="Maintenance">🚧</a> <a href="#research-bendyarm" title="Research">🔬</a> <a href="https://github.com/AleoHQ/welcome/pulls?q=is%3Apr+reviewed-by%3Abendyarm" title="Reviewed Pull Requests">👀</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/mdelle1"><img src="https://avatars.githubusercontent.com/u/108158289?v=4?s=100" width="100px;" alt="mdelle1"/><br /><sub><b>mdelle1</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=mdelle1" title="Documentation">📖</a> <a href="#research-mdelle1" title="Research">🔬</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://victorsintnicolaas.com/"><img src="https://avatars.githubusercontent.com/u/24724627?v=4?s=100" width="100px;" alt="vicsn"/><br /><sub><b>vicsn</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=vicsn" title="Documentation">📖</a> <a href="#research-vicsn" title="Research">🔬</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://move-book.com/"><img src="https://avatars.githubusercontent.com/u/8008055?v=4?s=100" width="100px;" alt="Damir Shamanaev"/><br /><sub><b>Damir Shamanaev</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=damirka" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://louiswt.github.io/"><img src="https://avatars.githubusercontent.com/u/22902565?v=4?s=100" width="100px;" alt="LouisWT"/><br /><sub><b>LouisWT</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=LouisWT" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/jules"><img src="https://avatars.githubusercontent.com/u/30194392?v=4?s=100" width="100px;" alt="jules"/><br /><sub><b>jules</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=jules" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/errol-drummond-354b8885/"><img src="https://avatars.githubusercontent.com/u/57955633?v=4?s=100" width="100px;" alt="EDGD"/><br /><sub><b>EDGD</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=EDGDrummond" title="Documentation">📖</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/ofloxacin"><img src="https://avatars.githubusercontent.com/u/9795941?v=4?s=100" width="100px;" alt="ofloxacin"/><br /><sub><b>ofloxacin</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=ofloxacin" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/SyedImam1998"><img src="https://avatars.githubusercontent.com/u/52135949?v=4?s=100" width="100px;" alt="Syed Imam"/><br /><sub><b>Syed Imam</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=SyedImam1998" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/B1boid"><img src="https://avatars.githubusercontent.com/u/47173672?v=4?s=100" width="100px;" alt="B1boid"/><br /><sub><b>B1boid</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=B1boid" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/CrypticDriver"><img src="https://avatars.githubusercontent.com/u/107245892?v=4?s=100" width="100px;" alt="CrypticDriver"/><br /><sub><b>CrypticDriver</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=CrypticDriver" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/rapiz1"><img src="https://avatars.githubusercontent.com/u/20105061?v=4?s=100" width="100px;" alt="Yujia Qiao"/><br /><sub><b>Yujia Qiao</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=rapiz1" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/joshbeal"><img src="https://avatars.githubusercontent.com/u/3038886?v=4?s=100" width="100px;" alt="Josh Beal"/><br /><sub><b>Josh Beal</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=joshbeal" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/unordered-set"><img src="https://avatars.githubusercontent.com/u/78592281?v=4?s=100" width="100px;" alt="Kostyan"/><br /><sub><b>Kostyan</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=unordered-set" title="Documentation">📖</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://detailyang.github.io/"><img src="https://avatars.githubusercontent.com/u/3370345?v=4?s=100" width="100px;" alt="detailyang"/><br /><sub><b>detailyang</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=detailyang" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://about.me/schaeff"><img src="https://avatars.githubusercontent.com/u/7441798?v=4?s=100" width="100px;" alt="Thibaut Schaeffer"/><br /><sub><b>Thibaut Schaeffer</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=Schaeff" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/gluax"><img src="https://avatars.githubusercontent.com/u/16431709?v=4?s=100" width="100px;" alt="gluax"/><br /><sub><b>gluax</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=gluax" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/graemecode"><img src="https://avatars.githubusercontent.com/u/36094097?v=4?s=100" width="100px;" alt="Graeme"/><br /><sub><b>Graeme</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=graemecode" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/pkrasam"><img src="https://avatars.githubusercontent.com/u/4514654?v=4?s=100" width="100px;" alt="pk"/><br /><sub><b>pk</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=pkrasam" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/WietzeSlagman"><img src="https://avatars.githubusercontent.com/u/5808153?v=4?s=100" width="100px;" alt="Wietze"/><br /><sub><b>Wietze</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=WietzeSlagman" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/features/security"><img src="https://avatars.githubusercontent.com/u/27347476?v=4?s=100" width="100px;" alt="Dependabot"/><br /><sub><b>Dependabot</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=dependabot" title="Code">💻</a></td>
</tr>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/actions"><img src="https://avatars.githubusercontent.com/u/65916846?v=4?s=100" width="100px;" alt="actions-user"/><br /><sub><b>actions-user</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=actions-user" title="Documentation">📖</a></td>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/aleosys"><img src="https://avatars.githubusercontent.com/u/60269885?v=4?s=100" width="100px;" alt="aleosys"/><br /><sub><b>aleosys</b></sub></a><br /><a href="https://github.com/AleoHQ/welcome/commits?author=aleosys" title="Documentation">📖</a></td>
</tr>
</tbody>
<tfoot>
<tr>
<td align="center" size="13px" colspan="7">
<img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg">
<a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
</img>
</td>
</tr>
</tfoot>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
You may also find it helpful to join us on [Discord](https://discord.com/invite/aleo) to ask or answer questions.

0 comments on commit 8a47be5

Please sign in to comment.