Skip to content

Commit

Permalink
Update doc/README.md
Browse files Browse the repository at this point in the history
Fix namings, outdated links, and sample commands
  • Loading branch information
Fuzzbawls committed Jun 17, 2019
1 parent 5b4f73d commit 20f2513
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,63 +1,63 @@
PIVX Core
=====================
=============

Setup
---------------------
[PIVX Core](http://pivx.org/wallet) is the original PIVX client and it builds the backbone of the network. However, it downloads and stores the entire history of PIVX transactions; depending on the speed of your computer and network connection, the synchronization process can take anywhere from a few hours to a day or more. Thankfully you only have to do this once.

Running
---------------------
The following are some helpful notes on how to run PIVX on your native platform.
The following are some helpful notes on how to run PIVX Core on your native platform.

### Unix

Unpack the files into a directory and run:

- bin/32/pivx-qt (GUI, 32-bit) or bin/32/pivxd (headless, 32-bit)
- bin/64/pivx-qt (GUI, 64-bit) or bin/64/pivxd (headless, 64-bit)
- `bin/pivx-qt` (GUI) or
- `bin/pivxd` (headless)

### Windows

Unpack the files into a directory, and then run pivx-qt.exe.

### OSX
### macOS

Drag PIVX-Qt to your applications folder, and then run PIVX-Qt.

### Need Help?

* See the documentation at the [PIVX Wiki](https://en.bitcoin.it/wiki/Main_Page) ***TODO***
* See the documentation at the [PIVX Wiki](https://github.com/PIVX-Project/PIVX/wiki)
for help and more information.
* Ask for help on [BitcoinTalk](https://bitcointalk.org/index.php?topic=1262920.0) or on the [PIVX Forum](http://forum.pivx.org/).
* Join our Discord server [Discord Server](https://discord.pivx.org)
* Join one of our Slack groups [PIVX Slack Groups](https://pivx.org/slack-logins/) (Main community is replaced by Discord).

Building
---------------------
The following are developer notes on how to build PIVX on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.
The following are developer notes on how to build PIVX Core on your native platform. They are not complete guides, but include notes on the necessary libraries, compile flags, etc.

- [OSX Build Notes](build-osx.md)
- [Dependencies](dependencies.md)
- [macOS Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-windows.md)
- [Gitian Building Guide](gitian-building.md)

Development
---------------------
The Pivx repo's [root README](https://github.com/PIVX-Project/PIVX/blob/master/README.md) contains relevant information on the development process and automated testing.
The PIVX repo's [root README](/README.md) contains relevant information on the development process and automated testing.

- [Developer Notes](developer-notes.md)
- [Multiwallet Qt Development](multiwallet-qt.md)
- [Release Notes](release-notes.md)
- [Release Process](release-process.md)
- [Source Code Documentation (External Link)](https://dev.visucore.com/bitcoin/doxygen/) ***TODO***
- [Source Code Documentation (External Link)](https://www.fuzzbawls.pw/pivx/doxygen/)
- [Translation Process](translation_process.md)
- [Unit Tests](unit-tests.md)
- [Unauthenticated REST Interface](REST-interface.md)
- [Dnsseed Policy](dnsseed-policy.md)

### Resources

* Discuss on the [BitcoinTalk](https://bitcointalk.org/index.php?topic=1262920.0) or the [PIVX](http://forum.pivx.org/) forum.
* Join the [PIVX-Dev](https://pivx-dev.slack.com/) Slack group ([Sign-Up](https://pivx-dev.herokuapp.com/)).
* Join the [PIVX Discord](https://discord.pivx.org).

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
Expand All @@ -67,6 +67,6 @@ The Pivx repo's [root README](https://github.com/PIVX-Project/PIVX/blob/master/R

License
---------------------
Distributed under the [MIT/X11 software license](http://www.opensource.org/licenses/mit-license.php).
Distributed under the [MIT software license](/COPYING).
This product includes software developed by the OpenSSL Project for use in the [OpenSSL Toolkit](https://www.openssl.org/). This product includes
cryptographic software written by Eric Young ([eay@cryptsoft.com](mailto:eay@cryptsoft.com)), and UPnP software written by Thomas Bernard.

0 comments on commit 20f2513

Please sign in to comment.