mirrors/bitcoin-s
1
0
Fork 0
mirror of https://github.com/bitcoin-s/bitcoin-s.git synced 2024-11-19 01:40:55 +01:00
Code Issues Packages Projects Releases Wiki Activity

Make it clear on the getting-setup.md page that this is only for development, you can find binaries in getting-started.md (#2759)

Browse Source
This commit is contained in:
Chris Stewart 2021-03-05 06:10:29 -06:00 committed by GitHub
parent 8b6c0652a2
commit d03bb2d22d
2 changed files with 26 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/getting-setup.md
View File

@ -3,6 +3,10 @@ id: getting-setup
title: Getting Bitcoin-S installed on your machine
---
> This documentation is intended for setting up development of bitcoin-s.
> If you want to just install bitcoin-s rather than develop,
> see [getting-started](getting-started.md)
## Getting Setup With Bitcoin-S
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
@ -18,6 +22,7 @@ title: Getting Bitcoin-S installed on your machine
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Step 1: Java and Scala
To get started you will need Java, Scala, and some other nice tools installed, luckily the Scala team has an easy setup process!

43
docs/getting-started.md
View File

@ -15,16 +15,23 @@ If you are a professional working a cryptocurrency business and
have feedback on how to make your lives easier, please reach out on [slack](https://join.slack.com/t/suredbits/shared_invite/zt-eavycu0x-WQL7XOakzQo8tAy7jHHZUw),
[gitter](https://gitter.im/bitcoin-s-core/) or [twitter](https://twitter.com/Chris_Stewart_5/)!
## If you want to setup Bitcoin-S locally
Then go to [this document](getting-setup.md).
## Getting prebuilt artifacts
If you want to add Bitcoin-S to your project, follow the
instructions for your build tool
### Java binaries
### Jars
Please download these from our latest [release on github](https://github.com/bitcoin-s/bitcoin-s/releases/tag/v0.5.0)
### Docker
We publish docker images to docker hub on every PR merge and tag on github.
You can obtain the images for both the app server and oracle server on these
docker hub repos
[bitcoin-s-server docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated)
[bitcoin-s-oracle-server docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated)
### Library jars
Add this to your `build.sbt`:
@ -79,20 +86,12 @@ The repo for snapshots, which are published after everytime something is merged
https://oss.sonatype.org/content/repositories/snapshots/org/bitcoin-s/
### Docker
We publish docker images to docker hub on every PR merge and tag on github.
You can obtain the images for both the app server and oracle server on these
docker hub repos
[bitcoin-s docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-server/tags?page=1&ordering=last_updated)
[oracle-server docker hub repo](https://hub.docker.com/r/bitcoinscala/bitcoin-s-oracle-server/tags?page=1&ordering=last_updated)
## Building JARs yourself
If you want to build Bitcoin-S JARs yourself, you need to use the
[sbt](https://www.scala-sbt.org/) build tool. Once you have sbt
installed, run `sbt publishLocal`. This places the required JAR
files in your `.ivy2/local` folder. On Linux, this is located at
`$HOME/.ivy2/local/` by default.
Please see [getting-setup.md](getting-setup.md)
## If you want to setup Bitcoin-S locally for development
Please see [getting-setup.md](getting-setup.md)