Skip to content

Commit

Permalink
* Fixed issue #21 - /ci/ant/setupenv.bat is missing. Updated document…
Browse files Browse the repository at this point in the history
…ation appropriately.

* Fixed issue #32 - rapidassist outside of win32arduino. Created 'Submodule dependencies' section in INSTALL.md documentation.
* Fixed issue #33 - Wrong syntax for variables on windows. Created both Windows and Linux build step sections.

* Updated product version to v2.2.3.

Updated INSTALL.md:
* Created 'Submodule dependencies' section in INSTALL.md documentation.
* Created both Windows and Linux build step sections.
  • Loading branch information
end2endzone committed Aug 29, 2018
1 parent 9314e37 commit bfd8c11
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 18 deletions.
6 changes: 6 additions & 0 deletions CHANGES
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
Changes for 2.2.3:

* Fixed issue #21 - /ci/ant/setupenv.bat is missing. Updated documentation appropriately.
* Fixed issue #32 - rapidassist outside of win32arduino. Created 'Submodule dependencies' section in INSTALL.md documentation.
* Fixed issue #33 - Wrong syntax for variables on windows. Created both Windows and Linux build step sections.

Changes for 2.2.2:

* Fixed issue #30 - Missing build step in v2.2.1.
Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ endif()
MESSAGE("")
SET(WIN32ARDUINO_MAJOR_VERSION 2)
SET(WIN32ARDUINO_MINOR_VERSION 2)
SET(WIN32ARDUINO_PATCH_VERSION 2)
SET(WIN32ARDUINO_PATCH_VERSION 3)
SET(WIN32ARDUINO_PRERELEASE_VERSION "") #i.e: rc1
SET(WIN32ARDUINO_METADATA_VERSION "") #i.e: build.45
SET(WIN32ARDUINO_VERSION_STRING ${WIN32ARDUINO_MAJOR_VERSION}.${WIN32ARDUINO_MINOR_VERSION}.${WIN32ARDUINO_PATCH_VERSION})
Expand Down
96 changes: 79 additions & 17 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ The library does not provide an installation package. It is deployed using a zip

The following steps show how other projects can find and use the library:

1) Download the source code from an existing [tags](http://github.com/end2endzone/win32Arduino/tags) and extract the content to a local directory (for example `c:\projects\win32Arduino` or `~/dev/win32Arduino`).
1) [Clone](https://git-scm.com/docs/git-clone) the source code from an existing [tags](http://github.com/end2endzone/win32Arduino/tags) into a local directory (for example `c:\projects\win32Arduino` or `~/dev/win32Arduino`).

2) Define the environment variable `WIN32ARDUINO_HOME` to the location where the source code was extracted.
2) Define the environment variable `WIN32ARDUINO_HOME` to the location where the source code was cloned.

3) Build the source code according to the build instructions.



Expand All @@ -20,17 +22,26 @@ This section explains how to compile and build the software and how to get a dev
## Prerequisites ##


### Software Requirements ###
The following software must be installed on the system for compiling source code:
### Submodule dependencies ###

* [Google C++ Testing Framework v1.6.0](https://github.com/google/googletest/tree/release-1.6.0) (untested with other versions)
* [CMake](http://www.cmake.org/) v3.4.3 (or newer)
win32Arduino uses [git submodules](https://git-scm.com/docs/git-submodule) to automatically handle dependencies to other git repositories.

The following submodules are required for compiling the library:
* [Google C++ Testing Framework v1.6.0](https://github.com/google/googletest/tree/release-1.6.0)
* [RapidAssist v0.3.4](https://github.com/end2endzone/RapidAssist/tree/v0.3.4)

After cloning the repository, submodule dependencies must be updated using `git submodule update --init --recursive` command run at the root of the repository. The submodule dependencies are stored in `lib/` directory.

For using [Continuous Integration](#continuous-integration) scripts, the following software must be installed on the system:
If the source code was downloaded from a zip archive, all submodule directories in the archive are empty and must be downloaded manually. Please make sure that downloaded version matches the version expected by win32Arduino.

* [Java SE Runtime Environment](http://www.oracle.com/technetwork/java/javase/downloads/index.html) version 8 (or newer).
* [Apache Ant(TM)](https://ant.apache.org/bindownload.cgi) version 1.8.4 (or newer)
The submodule dependencies does not need to be build and install individually before building win32Arduino source code. They will be included as part of the win32Arduino's build system at cmake configuration time.



### Software Requirements ###
The following software must be installed on the system for compiling source code:

* [CMake](http://www.cmake.org/) v3.4.3 (or newer)



Expand All @@ -53,24 +64,74 @@ These are the base requirements to build and use win32Arduino:

## Build steps ##

The following steps show how to build the library:
The following steps show how to build the library for each specific platform:


### Windows ###

1) Open a command prompt and browse to the location where the source code was extracted.

2) Define the environment variable `WIN32ARDUINO_HOME` by executing the following command:

`set WIN32ARDUINO_HOME=%cd%`

Note that `%cd%` is an environment variable that expands to the path of the current directory.

3) Define the environment variable `GOOGLETEST_HOME` by executing the following command:

1) Define the environment variable `WIN32ARDUINO_HOME` to the location where the source code was extracted.
`set GOOGLETEST_HOME=%WIN32ARDUINO_HOME%\lib\googletest`

2) Define the environment variable `GOOGLETEST_HOME` such that `GOOGLETEST_HOME=$WIN32ARDUINO_HOME/lib/googletest`.
4) Define the environment variable `RAPIDASSIST_HOME` by executing the following command:

3) Define the environment variable `RAPIDASSIST_HOME` such that `RAPIDASSIST_HOME=$WIN32ARDUINO_HOME/lib/RapidAssist`.
`set RAPIDASSIST_HOME=%WIN32ARDUINO_HOME%\lib\RapidAssist`

4) Configure the _Visual Studio solution_ or the _Makefile_ using the following commands:
5) Generate Visual Studio solution by executing the following commands:

* cd /d %WIN32ARDUINO_HOME%
* mkdir build
* cd build
* cmake ..

6) Build the source code.
1) From the command line using the command: `cmake --build . --config Release`.

or

2) From the Visual Studio IDE (aka GUI) by executing the following:

* Click on `win32Arduino.sln` to open Visual Studio IDE.
* Click on menu `Build` and select `Build Solution`. (The `F7` key also launches the compiler)
* Wait for the compilation to complete.
* Exit Visual Studio.



### Linux ###

1) Open a terminal and browse to the location where the source code was extracted.

2) Define the environment variable `WIN32ARDUINO_HOME` by executing the following command:

`export WIN32ARDUINO_HOME=$PWD`

Note that `$PWD` is an environment variable that expands to the path of the current directory.

3) Define the environment variable `GOOGLETEST_HOME` by executing the following command:

`export GOOGLETEST_HOME=$WIN32ARDUINO_HOME/lib/googletest`

4) Define the environment variable `RAPIDASSIST_HOME` by executing the following command:

`export RAPIDASSIST_HOME=$WIN32ARDUINO_HOME/lib/RapidAssist`

5) Generate the _Makefile_ using the following commands:

* cd $WIN32ARDUINO_HOME
* mkdir build
* cd build
* cmake ..

5) Build the source code:
1) On Windows, run `cmake --build . --config Release` or open `win32Arduino.sln` with Visual Studio.
2) On Linux, run `make` command.
6) Build the source code from the command line using the command: `make`.



Expand Down Expand Up @@ -102,3 +163,4 @@ To run tests, open a shell prompt and browse to the `build/bin` folder and run `
Test results are saved in junit format in file `win32Arduino_unittest.x86.debug.xml` or `win32Arduino_unittest.x86.release.xml` depending on the selected configuration.

The latest test results are available at the beginning of the [README.md](README.md) file.

0 comments on commit bfd8c11

Please sign in to comment.