Skip to content

Commit 8672a6e

Browse files
authored
Merge pull request hyperledger-indy#963 from fabienpe/indy
Small corrections to documentation.
2 parents 65a1a75 + f14f898 commit 8672a6e

File tree

2 files changed

+31
-30
lines changed

2 files changed

+31
-30
lines changed

doc/windows-build.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@
44

55
1. Setup a windows virtual machine. Free images are available at [here](https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/)
66
1. Launch the virtual machine
7-
1. Download Visual Studio Community Edition 2017
7+
1. Download Visual Studio Community Edition 2017 (these instructions also work with Visual Studio Professional 2017)
88
1. Check the boxes for the _Desktop development with C++_ and _Linux Development with C++_
99
1. In the summary portion on the right hand side also check _C++/CLI support_
1010
1. Click install
1111
1. Download git-scm for windows [here](https://git-scm.com/downloads/win)
1212
1. Install git for windows using:
13-
1. _Use Git from Git Bash Only_ so it doesn't change any path settings of the command prompt
14-
1. _Checkout as is, commit Unix-style line endings_. You shouldn't be commiting anything anyway but just in case
15-
1. _Use MinTTY_
16-
1. Check all the boxes for:
17-
1. Enable file system caching
18-
1. Enable Git Credential Manager
19-
1. Enable symbolic links
13+
1. _Use Git from Git Bash Only_ so it doesn't change any path settings of the command prompt
14+
1. _Checkout as is, commit Unix-style line endings_. You shouldn't be commiting anything anyway but just in case
15+
1. _Use MinTTY_
16+
1. Check all the boxes for:
17+
1. Enable file system caching
18+
1. Enable Git Credential Manager
19+
1. Enable symbolic links
2020
1. Download rust for windows [here](https://www.rust-lang.org/en-US/install.html)
21-
1. Choose installation option *1*
21+
1. Choose installation option *1*
2222

2323
## Get/build dependencies
2424

@@ -56,19 +56,19 @@ git clone https://github.com/hyperledger/indy-sdk.git
5656

5757
Download http://www.sqlite.org/2017/sqlite-amalgamation-3180000.zip
5858

59-
Create empty static library project and add sqlite.c file and 2 headers from extracted
59+
Create an empty static library project in Visual Studio and add `sqlite.c` file and 2 headers from extracted
6060
archive. Then just build it.
6161

6262
### Build libzmq
6363

64-
Follow to https://http://zeromq.org/intro.
64+
Follow to http://zeromq.org/intro.
6565
- Download sources from last stable release for Windows.
66-
- launch zeromq-x.x.x/builds/msvc/vs2015/libzmq.sln.
67-
- if necessary change solution platforms on x64(if you are working on x64 arch).
68-
- on main menu bar choose build->build libzmq.
69-
- if build project was succeed, in path zeromq-x.x.x/bin/x64/Debug/vXXX/dynamic has appeared
70-
two files libzmq.dll and libzmq.lib.
71-
- rename libzmq.lib to zmq.lib.
66+
- Open `zeromq-x.x.x/builds/msvc/vs2015/libzmq.sln` with Visual Studio
67+
- If necessary change solution platforms on x64(if you are working on x64 arch).
68+
- On main menu bar choose build->build libzmq.
69+
- If build project was successful, two files `libzmq.dll` and `libzmq.lib` should appear
70+
in path `zeromq-x.x.x/bin/x64/Debug/vXXX/dynamic`.
71+
- rename `libzmq.lib` to `zmq.lib`.
7272

7373
## Build
7474

@@ -82,18 +82,19 @@ Follow to https://http://zeromq.org/intro.
8282
```
8383

8484
Note that depending on the version of Visual Studio placement of vcvars64.bat can be different. For example, it can be
85-
`C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat`
86-
- execute "C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"
85+
`"C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat"`
86+
- Execute `"C:\Program Files (x86)\Microsoft Visual Studio\2017\Community\VC\Auxiliary\Build\vcvars64.bat"`
8787
- Point path to this directory using environment variables:
88-
- set INDY_PREBUILT_DEPS_DIR=C:\BIN\x64
89-
- set INDY_CRYPTO_PREBUILT_DEPS_DIR=C:\BIN\x64
90-
- set MILAGRO_DIR=C:\BIN\x64
91-
- set LIBZMQ_PREFIX=C:\BIN\x64
92-
- set SODIUM_LIB_DIR=C:\BIN\x64
93-
- set OPENSSL_DIR=C:\BIN\x64
94-
- set PATH to find .dlls:
95-
- set PATH=C:\BIN\x64\lib;%PATH%
96-
- change dir to indy-sdk/libindy and run cargo (you may want to add --release --target x86_64-pc-windows-msvc keys to cargo)
88+
- `set INDY_PREBUILT_DEPS_DIR=C:\BIN\x64`
89+
- `set INDY_CRYPTO_PREBUILT_DEPS_DIR=C:\BIN\x64`
90+
- `set MILAGRO_DIR=C:\BIN\x64`
91+
- `set LIBZMQ_PREFIX=C:\BIN\x64`
92+
- `set SODIUM_LIB_DIR=C:\BIN\x64`
93+
- `set OPENSSL_DIR=C:\BIN\x64`
94+
- Set PATH to find .dlls:
95+
- `set PATH=C:\BIN\x64\lib;%PATH%`
96+
- change dir to `indy-sdk/libindy` and run `cargo build` (you may want to add `--release --target x86_64-pc-windows-msvc`
97+
keys to cargo)
9798

9899
## openssl-sys workaround
99100

@@ -109,7 +110,7 @@ and add
109110
println!("cargo:rustc-link-lib=dylib=gdi32");
110111
```
111112

112-
to the end of main() function.
113+
to the end of `main()` function.
113114

114115
Then try to rebuild whole project.
115116

wrappers/python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Pull requests welcome!
1212
pip install python3-indy
1313

1414
Note that before you can use python wrapper you must install c-callable SDK.
15-
See the section "How-to-install" in [Indy SDK](README.md)
15+
See the section "Installing the SDK" in the [Indy SDK documentation](../../README.md#installing-the-sdk)
1616

1717
### How to build
1818

0 commit comments

Comments
 (0)