You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-8Lines changed: 5 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,9 @@
1
1
2
2
# Prepare your build environment
3
-
- Create a folder called fesapiEnv.
3
+
- Create a folder called fetpapiEnv.
4
4
- In this folder create the three following folders
5
5
- build
6
-
- fetpapi (Git clone this repository into this folder "fetpapi". You should then have a path fesapiEnv/fetpapi/src)
6
+
- fetpapi (Git clone this repository into this folder "fetpapi". You should then have a path fetpapiEnv/fetpapi/src)
7
7
- dependencies
8
8
- The following compilers are known to work (used in CI)
9
9
- gcc from version 4.8
@@ -15,22 +15,19 @@ Download (build and install if necessary) third party libraries:
15
15
- (OPTIONALLY) OpenSSL : version 1.1 is known to work.
16
16
- (OPTIONALLY) [FESAPI](https://github.com/F2I-Consulting/fesapi/releases) : All versions from version 2.7.0.0 should be ok.
17
17
18
-
We advise you to install these third party libraries respectively into
19
-
- fesapiEnv/dependencies/boost-particularVersion
20
-
- fesapiEnv/dependencies/avro-particularVersion
21
18
# Configure the build
22
19
FETPAPI uses cmake as its build tool. A 3.12 version or later of cmake is required https://cmake.org/download/. We also recommend using cmake-gui (already included in the bin folder of the binary releases of cmake) which provides a graphical user interface on top of cmake. If you want to use cmake in command line, you would find example in [Github Actions file](./.github/workflows/github-actions.yml). Follow the below instructions :
23
20
24
-
- yourPath/fesapiEnv/fetpapi defines where is the source code folder
25
-
- yourPath/fesapiEnv/build/theNameYouWant defines where to build the binaries
21
+
- yourPath/fetpapiEnv/fetpapi defines where is the source code folder
22
+
- yourPath/fetpapiEnv/build/theNameYouWant defines where to build the binaries
26
23
- Click on "Configure" button and select your favorite compiler : it will raise several errors.
27
24
- give real path and files to the following cmake variables:
28
25
- BOOST
29
26
- Boost_INCLUDE_DIR : the directory where you can find the directory named "boost" which contain all BOOST headers
30
27
- AVRO (using [our own cmake find module](./cmake/modules/FindAVRO.cmake))
31
28
- (ONLY IF NOT AUTOMATICALLY FOUND) AVRO_ROOT : The path to the folder containing include and lib folders of AVRO
32
29
- Click again on "Configure" button. You should no more have errors so you can now click on "Generate" button.
33
-
- You can now build your solution with your favorite compiler (and linker) using the generated solution in yourPath/fesapiEnv/build/theNameYouWant
30
+
- You can now build your solution with your favorite compiler (and linker) using the generated solution in yourPath/fetpapiEnv/build/theNameYouWant
34
31
- OPTIONALLY, you can also set the variables WITH_DOTNET_WRAPPING, WITH_PYTHON_WRAPPING to true if you want to also generate wrappers on top of FETPAPI for these two other programming languages. Don't forget to click again on "Configure" button once you changed the value of these two variables.
35
32
- You will then have to also provide the path to the SWIG (version 3 as a mininum version) executable http://swig.org/download.html in the SWIG_EXECUTABLE variable (and click again on "Configure" button)
36
33
- you will find the wrappers in fetpapi/cs/src (fetpapi/cs also contains a VS2015 project for the wrappers) or fetpapi/python/src
Copy file name to clipboardExpand all lines: doc/mainpage.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
FETPAPI is a library helping developers who want to develope an ETP™ client or server into a software.
1
+
FETPAPI is a library helping developers who want to develop an ETP™ client or server into a software.
2
2
3
3
Key functionalities are:
4
4
- Open source (license Apache 2.0)
@@ -12,4 +12,4 @@ Key functionalities are:
12
12
In this documentation, you would find all FETPAPI classes and their documentation into the **Classes** tab button above.
13
13
Please feel very free to participate to this documentation by providing pull request on Github or comments on the [FETPAPI forum](https://discourse.f2i-consulting.com/c/etp/7).
14
14
15
-
<fontsize="1"> ETP is a trademark or registered trademark of Energistics Consortium, Inc.</font>
15
+
<em>ETP is a trademark or registered trademark of Energistics Consortium, Inc.</em>
0 commit comments