-
Notifications
You must be signed in to change notification settings - Fork 1
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
0 additions
and
55 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,56 +1 @@ | ||
|  | ||
|
|
||
| #### TurtleCoin is a fun, fast, and easy way to send money to friends and businesses | ||
|
|
||
| [](http://chat.turtlecoin.lol) [](http://latest.turtlecoin.lol) [](https://github.com/turtlecoin/turtlecoin/graphs/contributors) [](https://github.com/turtlecoin/turtlecoin/issues)  | ||
|
|
||
| ### Contributing to TurtleCoin | ||
|
|
||
| We are a community of people across the world giving our time to make this software better. There are many ways you can help or join us: | ||
|
|
||
| - If you'd like to report a bug, [fill out a bug report](https://github.com/turtlecoin/turtlecoin/issues/new?template=bug_report.md) | ||
| - If you'd like to submit code for a bug you fixed, [submit a pull-request](https://github.com/turtlecoin/turtlecoin/compare) | ||
| - If you're a tester submitting tests you've done on a Release Candidate, [click here](https://github.com/turtlecoin/turtlecoin/issues/new?template=release-candidate.md) | ||
| - If you're a beginner developer, and want a list of easy things you can accomplish to help, [click here for a list of TODOs](https://github.com/turtlecoin/turtlecoin/labels/GOOD%20FIRST%20ISSUE) | ||
| - **Everyone else just click the ★ star at the top of this repository 😊 It really helps us out!** | ||
|
|
||
| For anyone else wishing to help the community or who needs answers to questions not covered in this document, join us in our [Discord Chat](http://chat.turtlecoin.lol) here. | ||
|
|
||
| ### TurtleCoin Build Branches | ||
|
|
||
|  **Master** | ||
|  **Development** | ||
|
|
||
| ### Installing TurtleCoin | ||
|
|
||
| To use TurtleCoin, you'll need a way to connect to the network, and a wallet to hold your funds. This software includes those things for you, you can compile it yourself, or you can download the ones that we have compiled for you. | ||
|
|
||
| **Click here to download: http://latest.turtlecoin.lol** | ||
|
|
||
| To compile from sourcecode yourself, [click here for build instructions](https://github.com/turtlecoin/turtlecoin/blob/development/COMPILE.md). | ||
|
|
||
| ### Getting Started Fast | ||
|
|
||
| Everyone starts somewhere. If you're new or returning, you'll probably want to get in sync with the network so you can use your funds. Syncing from your own node is faster than syncing from a remote node. Here are some handy links to get you there as soon as possible. | ||
|
|
||
| - **Use checkpoints** - Checkpoints help your node sync faster, [learn more](http://checkpoints.turtlecoin.lol/use.html) or [download here](http://checkpoints.turtlecoin.lol) | ||
| - **Learn things** - Syncing will take time, to help pass that time [learning how to use TRTL](https://docs.turtlecoin.lol/) | ||
| - **Backup your keys** - You can generate a wallet right inside the software, or use [this generator](https://turtlecoin.lol/wallet/) that will make a [printable physical paper wallet](https://docs.turtlecoin.lol/guides/wallets/making-a-wallet) to put in a safe place for later. | ||
|
|
||
| ### A note for contributing developers | ||
|
|
||
| Hello, and thank you for helping us! Our work makes use of many brilliant projects from other communities who contributed their code which helped us get to where we are now. To make sure we're always doing things the right way, we try to make sure we get the proper license header in every file we modify. By the terms of this project's license, any open source project may use our software, but the licenses may only be appended to, not altered. | ||
|
|
||
| See [src/config/CryptoNoteConfig.h](https://github.com/turtlecoin/turtlecoin/commit/28cfef2575f2d767f6e512f2a4017adbf44e610e) for an example. | ||
|
|
||
| ``` | ||
| // Copyright (c) 2012-2017, The CryptoNote developers, The Bytecoin developers | ||
| // Copyright (c) 2014-2018, The Monero Project | ||
| // Copyright (c) 2018-2020, The TurtleCoin Developers | ||
| // | ||
| // Please see the included LICENSE file for more information. | ||
| ``` | ||
|
|
||
| ### Contributing Projects | ||
|
|
||
| [](https://cryptonote.org/)[](https://bytecoin.org/)[](https://web.getmonero.org/)[](http://forknote.net/)[](https://turtlecoin.lol) |