mirror of
https://github.com/bisq-network/bisq.git
synced 2024-11-19 09:52:23 +01:00
Merge branch 'docs'
This commit is contained in:
Chris Beams
commit
154641eb40
51
README.md
51
README.md
@ -1,26 +1,51 @@
|
||||
|
||||
<img src="http://bitsquare.io/images/logo.png" width="240"/>
|
||||
|
||||
[](https://travis-ci.org/bitsquare/bitsquare)
|
||||
|
||||
Bitsquare is a cross-platform application that allows users to trade fiat money (dollars, euros, etc) for bitcoin without relying on centralized exchanges such as Coinbase, Bitstamp or (the former) Mt. Gox.
|
||||
|
||||
What is Bitsquare?
|
||||
------------------
|
||||
|
||||
Bitsquare is a cross-platform desktop application that allows users to trade fiat money (dollars, euros, etc) for bitcoin without relying on centralized exchanges such as Coinbase, Bitstamp or (the former) Mt. Gox.
|
||||
|
||||
By running Bitsquare on their local machine, 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, a market is established.
|
||||
|
||||
There are no central points of control or failure in the Bitsquare network. There are no trusted third parties. When two parties agree to trade fiat money for bitcoin, the bitcoin to be bought or sold is held in escrow using the multisignature transaction capabilities built in to the bitcoin protocol.
|
||||
There are no central points of control or failure in the Bitsquare network. There are no trusted third parties. When two parties agree to trade fiat money for bitcoin, the bitcoin to be bought or sold is held in escrow using multisignature transaction capabilities native to the bitcoin protocol.
|
||||
|
||||
Because the fiat money portion of any trade must be transferred via traditional means such as wire transfers, Bitsquare includes first-class support for human arbitration to handle any errors or disputes.
|
||||
Because the fiat money portion of any trade must be transferred via traditional means such as a wire transfer, Bitsquare incorporates first-class support for human arbitration to resolve any errors or disputes.
|
||||
|
||||
You can read about all of this and more in the [overview](), [whitepaper](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#), [arbitration](https://docs.google.com/document/d/1LJCRFdtM2Jn2Oiv49qRXwBDG8HZD0Hiedy8tNjErHps/edit) and [risk analysis](https://docs.google.com/document/d/1sHwU7K7C8Nl-fS4Z6X88L-NVJ_WBiKnsSpYpYfyqUXA/edit) documents. Several [screencasts](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#) are available as well.
|
||||
You can read about all of this and more in the [overview](http://bitsquare.io/images/overview.png), [whitepaper](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#), [arbitration](https://docs.google.com/document/d/1LJCRFdtM2Jn2Oiv49qRXwBDG8HZD0Hiedy8tNjErHps/edit) and [risk analysis](https://docs.google.com/document/d/1sHwU7K7C8Nl-fS4Z6X88L-NVJ_WBiKnsSpYpYfyqUXA/edit) documents. Several [screencasts](https://docs.google.com/document/d/1d3EiWZdaM89-P6MVhS53unXv2-pDpSFsN3W4kCGXKgY/edit#) are available as well.
|
||||
|
||||
|
||||
## Status
|
||||
Status
|
||||
------
|
||||
|
||||
The team is currently working toward an initial [v0.1.0](https://github.com/bitsquare/bitsquare/milestones/v0.1.0) release.
|
||||
The [team](https://github.com/orgs/bitsquare/people) is currently working on a series of pre-releases on the way to version 1.0. See the [roadmap](https://github.com/bitsquare/bitsquare/wiki/Roadmap) for details.
|
||||
|
||||
## Staying in touch
|
||||
**Alpha testers welcome!** Please see the [instructions for alpha testing](https://github.com/bitsquare/bitsquare/wiki/Alpha-Testing), where you'll find detailed information about downloading and using our native installers, [building from source](doc/build.md) and more.
|
||||
|
||||
* [Mailing list](https://groups.google.com/forum/#!forum/bitsquare)
|
||||
* [IRC](https://webchat.freenode.net/?channels=bitsquare)
|
||||
* [Twitter](https://twitter.com/bitsquare_)
|
||||
* [Email](mailto:team@bitsquare.io)
|
||||
* [Bitcointalk](https://bitcointalk.org/index.php?topic=647457)
|
||||
|
||||
Staying in Touch
|
||||
----------------
|
||||
|
||||
Contact the team and keep up to date using any of the following:
|
||||
|
||||
- The [#bitsquare](https://webchat.freenode.net/?channels=bitsquare) IRC channel on Freenode ([logs](https://botbot.me/freenode/bitsquare))
|
||||
- Our [mailing list](https://groups.google.com/forum/#!forum/bitsquare)
|
||||
- [@bitsquare_](https://twitter.com/bitsquare_) on Twitter
|
||||
- [team@bitsquare.io](mailto:team@bitsquare.io)
|
||||
- The [Bitsquare thread](https://bitcointalk.org/index.php?topic=647457) on the Bitcointalk forum
|
||||
- GitHub [Issues](https://github.com/bitsquare/bitsquare/issues)
|
||||
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
Bitsquare is [free software](https://www.gnu.org/philosophy/free-sw.html), licensed under version 3 of the [GNU Affero General Public License](https://gnu.org/licenses/agpl.html).
|
||||
|
||||
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:
|
||||
|
||||
1. Publish your changes under the same license, so as to ensure the software remains free.
|
||||
2. Use a name and logo substantially different than "Bitsquare" and the Bitsquare logo seen here. This allows for competition without confusion.
|
||||
|
||||
See [LICENSE](LICENSE) for complete details.
|
||||
|
||||
70
doc/build.md
Normal file
70
doc/build.md
Normal file
@ -0,0 +1,70 @@
|
||||
Building From Source
|
||||
====================
|
||||
|
||||
This guide will walk you through the process of building Bitsquare from source.
|
||||
|
||||
> _**NOTE:** For most users, building from source is not necessary. See the [releases page](https://github.com/bitsquare/bitsquare/releases), where you'll find installers for Windows, Linux and Mac OS X._
|
||||
|
||||
|
||||
For the impatient
|
||||
-----------------
|
||||
|
||||
What follows is explained in detail in the sections below, but for those who know their way around Java, git and Gradle, here are the instructions in a nutshell:
|
||||
|
||||
$ javac -version
|
||||
javac 1.8.0_20 # must be 1.8.0_20 or better
|
||||
|
||||
$ git clone https://github.com/bitsquare/bitsquare.git
|
||||
$ cd bitsquare
|
||||
$ ./gradlew build # (on *nix)
|
||||
--- or ---
|
||||
$ gradlew build # (on Windows)
|
||||
|
||||
When the build completes, you will find executables and installers specific to your platform in the `build/distributions/` directory.
|
||||
|
||||
|
||||
Prerequisites
|
||||
-------------
|
||||
|
||||
The only prerequisite for building Bitsquare is installing the Java Development Kit (JDK), version 8u20 or better.
|
||||
|
||||
To check the version of Java you currently have installed:
|
||||
|
||||
$ javac -version
|
||||
javac 1.8.0_20
|
||||
|
||||
If `javac` is not found, or your version is anything less than `1.8.0_20`, then you'll need to [download and install the latest JDK]( http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) for your platform.
|
||||
|
||||
> _**TIP:** Here are [instructions](http://www.webupd8.org/2014/03/how-to-install-oracle-java-8-in-debian.html) for installing the JDK via `apt` on Debian/Ubuntu systems._
|
||||
|
||||
|
||||
Steps
|
||||
-----
|
||||
|
||||
### 1. Get the source
|
||||
|
||||
The preferred approach is to clone the Bitsquare repository using [git](http://www.git-scm.com/):
|
||||
|
||||
git clone https://github.com/bitsquare/bitsquare.git
|
||||
|
||||
However, if you're not familiar with git or it is otherwise inconvenient to use, you can also download and extract a zip file of the latest sources at https://github.com/bitsquare/bitsquare/archive/master.zip.
|
||||
|
||||
|
||||
### 2. Build
|
||||
|
||||
Bitsquare uses [Gradle](http://www.gradle.org/), and the [Gradle wrapper](http://www.gradle.org/docs/current/userguide/gradle_wrapper.html) as a build system. This means you don't need to download or do anything other than run the following command within the `bitsquare` directory.
|
||||
|
||||
./gradlew build
|
||||
|
||||
> _**NOTE:** on Windows, leave out the `./` and simply run `gradlew build`._
|
||||
|
||||
|
||||
### 3. Run
|
||||
|
||||
When the build completes, you'll find executables and installers in the `build/distributions` directory.
|
||||
|
||||
|
||||
Problems?
|
||||
---------
|
||||
|
||||
If the instructions above don't work for you, please [raise an issue](https://github.com/bitsquare/bitsquare/issues/new?labels=%5Bbuild%5D). Thanks!
|
||||
Loading…
Reference in New Issue
Block a user