Skip to content

Commit 1ae86a0

Browse files
committed
Renamed INSTALL to INSTALL.md
Moved installing section from README.md to INSTALL.md
1 parent d06b863 commit 1ae86a0

File tree

3 files changed

+61
-59
lines changed

3 files changed

+61
-59
lines changed

INSTALL

Lines changed: 0 additions & 1 deletion
This file was deleted.

INSTALL.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Installing
2+
3+
This section explains how to compile and build the software and how to get a development environment running.
4+
5+
## Compatible with
6+
7+
bin2cpp is only available for the Windows platform and has been tested with the following version of Windows:
8+
9+
* Windows XP
10+
* Windows Vista
11+
* Windows 7
12+
13+
## Prerequisites
14+
15+
The following software must be installed on the system for compiling source code:
16+
17+
* Visual Studio 2010 (or newer) (There are plans to migrate the software to other platform. See [issue #9](https://github.com/end2endzone/bin2cpp/issues/9))
18+
* [Google Test v1.6.0](https://github.com/google/googletest/tree/release-1.6.0) (untested with other versions)
19+
* [CMake](http://www.cmake.org/) for compilation of Google Test library. (Tested with CMake 3.9.6)
20+
* [bin2cpp source code](https://github.com/end2endzone/bin2cpp)
21+
22+
## Build steps
23+
24+
### Google Test
25+
26+
1) Download googletest source code to your computer using one of the following:
27+
1) Download googletest as a [zip file](https://github.com/google/googletest/archive/release-1.6.0.zip) and extract to a temporary directory (for example c:\projects\third_party\googletest).
28+
2) Clone the git repository using the following commands:
29+
* git clone https://github.com/google/googletest.git c:\projects\third_party\googletest
30+
* cd /d c:\projects\third_party\googletest
31+
* git checkout release-1.6.0
32+
33+
2) Generate googletest Visual Studio 2010 solution using cmake. Enter the following commands:
34+
* cd c:\projects\third_party\googletest
35+
* mkdir msvc2010
36+
* cd msvc2010
37+
* cmake -G "Visual Studio 10 2010" -Dgtest_force_shared_crt=ON -DCMAKE_CXX_FLAGS_DEBUG=/MDd -DCMAKE_CXX_FLAGS_RELEASE=/MD "c:\projects\third_party\googletest"
38+
39+
3) Open the generated Visual Studio 2010 solution file located in
40+
***c:\projects\third_party\googletest\msvc2010\gtest.sln***
41+
42+
### Define environment variables
43+
Note: this step need to be executed once.
44+
45+
bin2cpp needs to know where the libraries of googletest are located (debug & release).
46+
Define the following environement variables:
47+
48+
| Name | Value |
49+
|--------------------------|----------------------------------------------|
50+
| GTEST_DEBUG_LIBRARIES | gtest.lib |
51+
| GTEST_RELEASE_LIBRARIES | gtest.lib |
52+
| GTEST_INCLUDE | c:\projects\third_party\googletest\include |
53+
| GTEST_LIBRARY_DIR | c:\projects\third_party\googletest\msvc2010 |
54+
55+
### bin2cpp
56+
57+
1) Download the [bin2cpp source code](https://github.com/end2endzone/bin2cpp/tags) and extract the content to a temporary directory (for example c:\projects\bin2cpp).
58+
59+
2) Open the Visual Studio 2010 solution file located in
60+
***c:\projects\bin2cpp\msvc\bin2cpp.sln***

README.md

Lines changed: 1 addition & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -223,64 +223,7 @@ int main(int argc, char* argv[])
223223
224224
# Installing
225225
226-
This section explains how to compile and build the software and how to get a development environment running.
227-
228-
## Compatible with
229-
230-
bin2cpp is only available for the Windows platform and has been tested with the following version of Windows:
231-
232-
* Windows XP
233-
* Windows Vista
234-
* Windows 7
235-
236-
## Prerequisites
237-
238-
The following software must be installed on the system for compiling source code:
239-
240-
* Visual Studio 2010 (or newer) (There are plans to migrate the software to other platform. See [issue #9](https://github.com/end2endzone/bin2cpp/issues/9))
241-
* [Google Test v1.6.0](https://github.com/google/googletest/tree/release-1.6.0) (untested with other versions)
242-
* [CMake](http://www.cmake.org/) for compilation of Google Test library. (Tested with CMake 3.9.6)
243-
* [bin2cpp source code](https://github.com/end2endzone/bin2cpp)
244-
245-
## Build steps
246-
247-
### Google Test
248-
249-
1) Download googletest source code to your computer using one of the following:
250-
1) Download googletest as a [zip file](https://github.com/google/googletest/archive/release-1.6.0.zip) and extract to a temporary directory (for example c:\projects\third_party\googletest).
251-
2) Clone the git repository using the following commands:
252-
* git clone https://github.com/google/googletest.git c:\projects\third_party\googletest
253-
* cd /d c:\projects\third_party\googletest
254-
* git checkout release-1.6.0
255-
256-
2) Generate googletest Visual Studio 2010 solution using cmake. Enter the following commands:
257-
* cd c:\projects\third_party\googletest
258-
* mkdir msvc2010
259-
* cd msvc2010
260-
* cmake -G "Visual Studio 10 2010" -Dgtest_force_shared_crt=ON -DCMAKE_CXX_FLAGS_DEBUG=/MDd -DCMAKE_CXX_FLAGS_RELEASE=/MD "c:\projects\third_party\googletest"
261-
262-
3) Open the generated Visual Studio 2010 solution file located in
263-
***c:\projects\third_party\googletest\msvc2010\gtest.sln***
264-
265-
### Define environment variables
266-
Note: this step need to be executed once.
267-
268-
bin2cpp needs to know where the libraries of googletest are located (debug & release).
269-
Define the following environement variables:
270-
271-
| Name | Value |
272-
|--------------------------|----------------------------------------------|
273-
| GTEST_DEBUG_LIBRARIES | gtest.lib |
274-
| GTEST_RELEASE_LIBRARIES | gtest.lib |
275-
| GTEST_INCLUDE | c:\projects\third_party\googletest\include |
276-
| GTEST_LIBRARY_DIR | c:\projects\third_party\googletest\msvc2010 |
277-
278-
### bin2cpp
279-
280-
1) Download the [bin2cpp source code](https://github.com/end2endzone/bin2cpp/tags) and extract the content to a temporary directory (for example c:\projects\bin2cpp).
281-
282-
2) Open the Visual Studio 2010 solution file located in
283-
***c:\projects\bin2cpp\msvc\bin2cpp.sln***
226+
Please refer to file [INSTALL.md](INSTALL.md) for details on how installing/building the application.
284227
285228
## Testing
286229
bin2cpp comes with unit tests which tests for multiple combinations to make sure that input files are always encoded without errors.

0 commit comments

Comments
 (0)