Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete files from docs folder #20

Merged
merged 1 commit into from
May 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion doc/.gitignore

This file was deleted.

2,459 changes: 0 additions & 2,459 deletions doc/Doxyfile.in

This file was deleted.

198 changes: 0 additions & 198 deletions doc/JSON-RPC-interface.md

This file was deleted.

94 changes: 3 additions & 91 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -1,93 +1,5 @@
Vincoin Core
=============
This is the main README file of Vincoin documentation.
Here will be added everything relevant that can help you easily understand the concepts of Vincoin protocol and familiarize yourself with terms from Vincoin world.

Setup
---------------------
Vincoin Core is the original Vincoin client and it builds the backbone of the network. It downloads and, by default, stores the entire history of Vincoin transactions, which requires a few hundred gigabytes of disk space. 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.

To download Vincoin Core, visit [vincoincore.org](https://vincoincore.org/en/download/).

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

### Unix

Unpack the files into a directory and run:

- `bin/vincoin-qt` (GUI) or
- `bin/vincoind` (headless)

### Windows

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

### macOS

Drag Vincoin Core to your applications folder, and then run Vincoin Core.

### Need Help?

* See the documentation at the [Vincoin Wiki](https://en.vincoin.it/wiki/Main_Page)
for help and more information.
* Ask for help on [Vincoin StackExchange](https://vincoin.stackexchange.com).
* Ask for help on #vincoin on Libera Chat. If you don't have an IRC client, you can use [web.libera.chat](https://web.libera.chat/#vincoin).
* Ask for help on the [VincoinTalk](https://vincointalk.org/) forums, in the [Technical Support board](https://vincointalk.org/index.php?board=4.0).

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

- [Dependencies](dependencies.md)
- [macOS Build Notes](build-osx.md)
- [Unix Build Notes](build-unix.md)
- [Windows Build Notes](build-windows.md)
- [FreeBSD Build Notes](build-freebsd.md)
- [OpenBSD Build Notes](build-openbsd.md)
- [NetBSD Build Notes](build-netbsd.md)
- [Android Build Notes](build-android.md)

Development
---------------------
The Vincoin repo's [root README](/README.md) contains relevant information on the development process and automated testing.

- [Developer Notes](developer-notes.md)
- [Productivity Notes](productivity.md)
- [Release Process](release-process.md)
- [Source Code Documentation (External Link)](https://doxygen.vincoincore.org/)
- [Translation Process](translation_process.md)
- [Translation Strings Policy](translation_strings_policy.md)
- [JSON-RPC Interface](JSON-RPC-interface.md)
- [Unauthenticated REST Interface](REST-interface.md)
- [Shared Libraries](shared-libraries.md)
- [BIPS](bips.md)
- [Dnsseed Policy](dnsseed-policy.md)
- [Benchmarking](benchmarking.md)
- [Internal Design Docs](design/)

### Resources
* Discuss on the [VincoinTalk](https://vincointalk.org/) forums, in the [Development & Technical Discussion board](https://vincointalk.org/index.php?board=6.0).
* Discuss project-specific development on #vincoin-core-dev on Libera Chat. If you don't have an IRC client, you can use [web.libera.chat](https://web.libera.chat/#vincoin-core-dev).

### Miscellaneous
- [Assets Attribution](assets-attribution.md)
- [vincoin.conf Configuration File](vincoin-conf.md)
- [CJDNS Support](cjdns.md)
- [Files](files.md)
- [Fuzz-testing](fuzzing.md)
- [I2P Support](i2p.md)
- [Init Scripts (systemd/upstart/openrc)](init.md)
- [Managing Wallets](managing-wallets.md)
- [Multisig Tutorial](multisig-tutorial.md)
- [Offline Signing Tutorial](offline-signing-tutorial.md)
- [P2P bad ports definition and list](p2p-bad-ports.md)
- [PSBT support](psbt.md)
- [Reduce Memory](reduce-memory.md)
- [Reduce Traffic](reduce-traffic.md)
- [Tor Support](tor.md)
- [Transaction Relay Policy](policy/README.md)
- [ZMQ](zmq.md)

License
---------------------
Distributed under the [MIT software license](/COPYING).
Reference link to official Bitcoin documentation: https://github.com/bitcoin/bitcoin/tree/master/doc
15 changes: 0 additions & 15 deletions doc/README_doxygen.md

This file was deleted.

23 changes: 0 additions & 23 deletions doc/README_windows.txt

This file was deleted.

Loading
Loading