on master help sign in
Include instructions in readme
commit39bc96e7f27f5c0a5604791999469cadbbade7ea authorFang <git@fang.io> dateThu 18 Apr 2019, 16:04 (8 years ago) parentd780bd5
1 file changed+19−1
README.md+19−1
README.md+19−1
@@ -4,7 +4,25 @@ An application for interacting with Azimuth.
44
55## Usage
66
7−To run Bridge, follow the instructions on the [latest release][rele] page.
7+### Requirements
8+
9+Python 3.7.2
10+
11+### Instructions
12+
13+1. To use Bridge, [download a release](https://github.com/urbit/bridge/releases) and unzip it (`bridge-$version.zip`).
14+2. Open up your command line interface (Terminal on MacOS, Command Prompt on Windows).
15+3. `cd` into the `bridge-$version` directory.
16+4. Run this command: `python3 -m http.server 5000 --bind 127.0.0.1`
17+5. You can then use Bridge by navigating to http://localhost:5000 using a web browser.
18+
19+### Verify checksums
20+
21+To validate your downloaded file's integrity, compare the lines in checksum.txt to SHA-256 hashes of the `bridge-$version` directory's contents.
22+
23+- On MacOS: `shasum -a 256 -c checksums.txt .`
24+- On Linux: `sha256sum -c checksums.txt .`
25+- On Windows: Go into the `build` directory and verify files individually with `CertUtil -hashFile [file_name] SHA256`
826
927## Development Notes
1028