Skip to content

Commit 7dc0b52

Browse files
authored
Merge pull request #1 from IBM/readme_edit
Update README.md
2 parents 35ab3ec + b40ec40 commit 7dc0b52

File tree

1 file changed

+25
-11
lines changed

1 file changed

+25
-11
lines changed

README.md

Lines changed: 25 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,39 @@
22

33
The Open Cryptography Kit for C to which this document refers is based on the C language and is usable by products that are based on C or C++.
44

5-
# Build for Linux 64
5+
## Build instructions
66

7+
For a debug build on any platform specify CONFIG=debug as an argument to make.
8+
9+
### Linux 64-bit
10+
11+
```bash
712
make -k -C icc OPSYS=AMD64_LINUX create_all
813
make -k -C icc OPSYS=AMD64_LINUX all
14+
```
915

10-
Other options include CONFIG=debug
11-
12-
# Build for Linux 32 bit
16+
### Linux 32-bit
1317

18+
```bash
1419
make -k -C icc OPSYS=LINUX create_all
1520
make -k -C icc OPSYS=LINUX all
21+
```
1622

17-
Other options as above
18-
19-
# Build for Windows 64
23+
### Windows 64-bit
2024

25+
```bash
2126
make -k -C icc OPSYS=WIN64_VS2022 create_all
2227
make -k -C icc OPSYS=WIN64_VS2022 all
23-
24-
Other options as above
25-
26-
Note this build is not constrained to MS VS 2022 but is tested on that platform
28+
```
29+
This build is not constrained to MS VS 2022 but is tested on that platform.
30+
#### Requirements
31+
Visual studio build tools are required, including mfc.
32+
The supported make is windows gnumake 3.81. Also required is NASM, common unix utilities for windows (ls, sh, mv, rm, patch, etc), strawberry perl, and openjdk.
33+
34+
Tested unix utilities are provided by msys2, or those packaged with the windows git installer.
35+
The tested openjdk is the Microsoft Build of OpenJDK 17.
36+
NASM should be added to the windows PATH environment variable.
37+
Run the appropriate vcvars.bat file in a cmd.exe or otherwise use a development console before running make.
38+
39+
Note: Windows utilities which use a Unix style PATH such as the gnumake available in msys2 are not supported.
40+
Note: Cygwin is not supported.

0 commit comments

Comments
 (0)