zecfoundation
/
zebra
mirror of https://github.com/ZcashFoundation/zebra.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zebra/README.md

32 lines
1.3 KiB
Markdown
Raw Normal View History

Add Zebra logotype.
2020-02-26 21:13:05 -08:00
![Zebra logotype](https://www.zfnd.org/images/zebra-logotype.png)
Create README.md
2019-10-25 09:48:46 -07:00
Fix linebreak
2020-04-21 23:48:18 -07:00
---
Add link to CI workflows on main
2020-04-22 00:09:30 -07:00
[![](https://github.com/ZcashFoundation/zebra/workflows/CI/badge.svg?branch=main)](https://github.com/ZcashFoundation/zebra/actions?query=workflow%3ACI+branch%3Amain)
Add badges to the readme
2020-04-21 23:39:17 -07:00
[![codecov](https://codecov.io/gh/ZcashFoundation/zebra/branch/main/graph/badge.svg)](https://codecov.io/gh/ZcashFoundation/zebra)
Add license badge
2020-04-22 00:02:19 -07:00
![License](https://img.shields.io/badge/license-MIT%2FApache--2.0-blue.svg)
Add badges to the readme
2020-04-21 23:39:17 -07:00
Create README.md
2019-10-25 09:48:46 -07:00
Hello! I am Zebra, an ongoing Rust implementation of a Zcash node.
Add LICENSE-MIT and LICENSE-APACHE and note in README.md Resolves #96
2019-11-14 11:17:58 -08:00
Add docs link to README
2020-01-24 14:55:55 -08:00
Zebra is a work in progress. It is developed as a collection of `zebra-*`
libraries implementing the different components of a Zcash node (networking,
chain structures, consensus rules, etc), and a `zebrad` binary which uses them.
Update zebrad docs and README.
2020-02-12 12:40:08 -08:00
Most of our work so far has gone into `zebra-network`, building a new
Reorganize the book. (#843) * Reorganize the book. This PR has one unfortunate change, which is that the README.md and CONTRIBUTING.md files in the book are symlinks to files in the parent directory. The motivation for this is to ensure that we don't maintain two copies of the same data, and that the landing page of the website matches the landing page of the Github repo, etc. However, I'm not sure whether these symlinks will work correctly on Windows. The alternatives are: - Duplicate the contents of the files and expect that people will know to keep them in sync; - Use relative links `../../README.md` in the `SUMMARY.md`. This seemed like it caused mdbook to dump the rendered files into the repository root rather than keeping them in the `book` directory. - Use a symlink (chosen option). This may not work on Windows but I think that the worst outcome would be that the book would be unbuildable unless someone used WSL or something. This seems like the least bad option. * Remove symlinks in favor of #include Turns out the symlinks aren't required!
2020-08-06 15:39:54 -07:00
networking stack for Zcash, `zebra-chain`, building foundational data
structures, `zebra-consensus`, implementing consensus rules, and
`zebra-state`, providing chain state.
[Zebra Website](https://zebra.zfnd.org).
Update zebrad docs and README.
2020-02-12 12:40:08 -08:00
Add docs link to README
2020-01-24 14:55:55 -08:00
[Rendered docs from the `main` branch](https://doc.zebra.zfnd.org).
Update zebrad docs and README.
2020-02-12 12:40:08 -08:00
[Join us on Discord](https://discord.gg/na6QZNd).
Add LICENSE-MIT and LICENSE-APACHE and note in README.md Resolves #96
2019-11-14 11:17:58 -08:00
## License
Update README.md Co-Authored-By: Henry de Valence <hdevalence@hdevalence.ca>
2019-11-14 11:22:23 -08:00
Zebra is distributed under the terms of both the MIT license
Add LICENSE-MIT and LICENSE-APACHE and note in README.md Resolves #96
2019-11-14 11:17:58 -08:00
and the Apache License (Version 2.0).
See [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT).