forked from zcash/zcash
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
22 additions
and
34 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,59 +1,47 @@ | ||
Ycash v4.4.1 | ||
<img align="right" width="120" height="80" src="https://www.ycash.xyz/y_sign.png"> | ||
# Ycash v4.4.1 | ||
|
||
What is Ycash? | ||
-------------- | ||
## Getting Started | ||
|
||
Ycash is a digital currency. For more information, see https://y.cash. | ||
|
||
[Ycash](https://www.ycash.xyz) is a chain fork of [Zcash](https://z.cash/). | ||
For a comparison of Ycash to Bitcoin, see https://y.cash/fact-sheet. | ||
|
||
This software is the Ycash client. It downloads and stores the entire history | ||
This software is the Ycash node. It downloads and stores the entire history | ||
of Ycash transactions; depending on the speed of your computer and network | ||
connection, the synchronization process could take a day or more once the | ||
blockchain has reached a significant size. | ||
|
||
#### :lock: Security Warnings | ||
|
||
(Coming soon) | ||
|
||
**Ycash is experimental and a work-in-progress.** Use at your own risk. | ||
|
||
#### :ledger: Deprecation Policy | ||
|
||
This release is considered deprecated 16 weeks after the release day. There | ||
is an automatic deprecation shutdown feature which will halt the node some | ||
time after this 16-week period. The automatic feature is based on block | ||
height. | ||
Ycash is a chain fork of Zcash. For most topics, you can rely on Zcash-related documentation, including the [user guide for zcashd](https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html). | ||
|
||
## Getting Started | ||
|
||
For most topics, you can rely on Zcash-related documentation. Supplemental Ycash-specific documentation will be hosted here: | ||
|
||
http://www.ycash.xyz/docs | ||
|
||
Refer also to the [Zcash user guide](https://zcash.readthedocs.io/en/latest/rtd_pages/rtd_docs/user_guide.html). | ||
## Need Help? | ||
|
||
### Need Help? | ||
* Visit https://y.cash | ||
* Ask for help in one of the [Ycash forums](https://y.cash/forums). | ||
|
||
* :blue_book: See the documentation at the [ReadTheDocs](https://zcash.readthedocs.io) | ||
for help and more information. | ||
* :incoming_envelope: Ask for help on the [Ycash Discord](https://discord.gg/Yz8rW7P). | ||
## Code of Conduct | ||
|
||
Participation in the Ycash project is subject to a | ||
[Code of Conduct](code_of_conduct.md). | ||
|
||
### Building | ||
## Building | ||
|
||
Follow the instructions for building Zcash: | ||
|
||
https://zcash.readthedocs.io/en/latest/rtd_pages/zcashd.html#install | ||
|
||
Build Ycash along with most dependencies from source by running: | ||
For any Ycash-specific build instructions, see the release notes. | ||
|
||
``` | ||
./zcutil/build.sh -j$(nproc) | ||
``` | ||
## Deprecation Policy | ||
|
||
Currently, Zcash is only officially supported on Debian and Ubuntu. See the | ||
[Debian / Ubuntu build](https://zcash.readthedocs.io/en/latest/rtd_pages/Debian-Ubuntu-build.html) | ||
for detailed instructions. | ||
This release is considered deprecated at a certain block height, | ||
at which point the node will halt and you will need to upgrade. | ||
See the release notes for the deprecation height for this release. | ||
|
||
License | ||
------- | ||
## License | ||
|
||
For license information see the file [COPYING](COPYING). |