Skip to content
This repository was archived by the owner on Apr 17, 2023. It is now read-only.

Commit b5668bf

Browse files
committed
Merge branch 'release/0.21.5'
2 parents 921acc8 + 0537142 commit b5668bf

40 files changed

+430
-258
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,23 @@ Blockstack for macOS contains a Blockstack Core API endpoint & a CORS proxy.
6262
*Note: npm dev runs a BrowserSync process that watches the assets in `/app`, then builds them and places them in `/build`, and in turn serves them up on port 3000. When changes are made to the original files, they are rebuilt and re-synced to the browser frames you have open.*
6363

6464

65+
### Windows
66+
67+
*Note: The installation instructions below are for setting up a development environment on Windows 10. If you are using Blockstack for the first time or are looking to try Blockstack out, please go to our [downloads page](https://blockstack.org/install) and install the version there.*
68+
69+
The Blockstack API and the Blockstack Browser run best in Docker. There is a provided CLI to help you build and launch `docker` images if you are not comfortable with `docker`:`launcher`. The CLI will pull down the images from our [Quay image repository](https://quay.io/organization/blockstack).
70+
71+
1. Download the [launcher script](https://raw.githubusercontent.com/blockstack/packaging/master/browser-core-docker/launcher) from our packaging repository.
72+
73+
2. In order to use the launcher script, you must have Docker installed and setup on your machine. Our [Windows installer](http://packages.blockstack.com/repositories/windows/) sets up Docker for you and uses the launcher script to start Blockstack Browser automatically. The same Windows installer can be found on the [Installing Blockstack README](https://github.com/blockstack/blockstack-core#installing-blockstack).
74+
75+
3. Run `./launcher pull`. This will fetch the latest docker images from our image repository.
76+
77+
4. Start the Blockstack Core API using `./launcher start`. This will start the Blockstack browser and a paired `blockstack-api` daemon. The first time you run this, it will create a `$HOME/.blockstack` directory to store your Blockstack Core API configuration and wallet. You will also need to create a password to protect these configurations.
78+
79+
5. When you are done, you can clean up your environment: `./launcher stop`
80+
81+
6582
## Building for macOS
6683

6784
1. Make sure you have a working installation of Xcode 9 or higher & valid Mac Developer signing certificate
797 Bytes
Loading
-26.8 KB
Loading
18 KB
Loading
47.7 KB
Loading
31.1 KB
Loading
104 KB
Loading
25.8 KB
Loading
49.7 KB
Loading
89.5 KB
Loading

0 commit comments

Comments
 (0)