c19d3a0742
This commit takes a pass through all documentation and scripts, replacing any remaining `mvn` commands with their `gradle` equivalents, replacing `target/*` paths with their `build/*` equivalents, and so on. Note that the instruction to install Maven has been removed entirely from documentation and scripts, as opposed to instructing users to install Gradle, because with the Gradle wrapper (the `gradlew` script in the root of this repository), it is unnecessary to install Gradle at all. Users may still do this with, e.g. `brew install gradle` if they like, but otherwise can get everything they need done with `./gradlew` commands. This commit also replaces lowercase 'bisq' with capitalized 'Bisq' where appropriate in documentation. Like the previous commit, this is a best-effort approach, and not all scripts are perfectly up-to-date and tested. Indeed, many of the docs and scripts we have now are essentially legacy documents and should probably be scrapped or reworked completely. |
||
|---|---|---|
| .idea | ||
| doc | ||
| gradle | ||
| package | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .travis.yml | ||
| build.gradle | ||
| CONTRIBUTING.md | ||
| gradlew | ||
| gradlew.bat | ||
| LICENSE | ||
| pom.xml | ||
| README.md | ||
| settings.gradle | ||
What is Bisq?
Bisq is a cross-platform desktop application that allows users to trade national currency (dollars, euros, etc) for bitcoin without relying on centralized exchanges such as Coinbase, Bitstamp or (the former) Mt. Gox.
By running Bisq on their local machines, users form a peer-to-peer network. Offers to buy and sell bitcoin are broadcast to that network, and through the process of offering and accepting these trades via the Bisq UI, a market is established.
There are no central points of control or failure in the Bisq network. There are no trusted third parties. When two parties agree to trade national currency for bitcoin, the bitcoin to be bought or sold is held in escrow using multisignature transaction capabilities native to the bitcoin protocol.
Because the national currency portion of any trade must be transferred via traditional means such as a wire transfer, Bisq incorporates first-class support for human arbitration to resolve any errors or disputes.
You can read about all of this and more in the whitepaper and arbitration documents. Several videos are available as well.
Status
Bisq has released the beta version on the 27th of April 2016. It is operational since that time without any major incident. Please follow the current development state at our road map. For the latest version checkout our releases page at Github.
Building from source
See doc/build.md.
Staying in Touch
Contact the team and keep up to date using any of the following:
- The Bisq website
- GitHub Issues
- The Bisq forum
- The #bisq IRC channel on Freenode
- Our contributor mailing list
- @bisq_network on Twitter
- The Bisq newsletter
License
Bisq is free software, licensed under version 3 of the GNU Affero General Public License.
In short, this means you are free to fork this repository and do anything with it that you please. However, if you distribute your changes, i.e. create your own build of the software and make it available for others to use, you must:
- Publish your changes under the same license, so as to ensure the software remains free.
- Use a name and logo substantially different than "Bisq" and the Bisq logo seen here. This allows for competition without confusion.
See LICENSE for complete details.