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
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
# If you just want some precompiled binaries (just to test for example)
2
-
- Please first look in the [assets](https://github.com/F2I-Consulting/fesapi/releases) of the releases if it as already provided
2
+
- Please first check in the [assets](https://github.com/F2I-Consulting/fesapi/releases) of the releases if your version has already been provided? For a Python version, just look at [PyPI](https://pypi.org/project/fesapi/).
3
3
- If not, create an [issue](https://github.com/F2I-Consulting/fesapi/issues/new?assignees=&labels=&projects=&template=feature_request.md) and ask for the version you would want.
4
4
# Prepare your build environment
5
5
- Create a folder called fesapiEnv.
@@ -23,7 +23,7 @@ We advise you to install these third party libraries respectively into
Fesapi 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 [Azure Pipeline file](./azure-pipelines.yml). Follow the below instructions :
26
+
FESAPI 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 :
27
27
28
28
- yourPath/fesapiEnv/fesapi defines where is the source code folder
29
29
- yourPath/fesapiEnv/build/theNameYouWant defines where to build the binaries
@@ -59,15 +59,14 @@ As a first way to start, we advise people to look at examples provided with FESA
59
59
- C++ : [in example/example.cpp](./example/example.cpp)
60
60
- C# : in cs/example/example.sln (Program.cs will be generated by cmake configuration when WITH_DOTNET_WRAPPING is ON, the source file is initially located [in cmake/Program.cs](./cmake/Program.cs))
61
61
- Java (JDK 1.5 and later) : in java/src/com/f2i_consulting/example/FesapiJavaExample.java (FesapiJavaExample.java will be generated by cmake configuration when WITH_JAVA_WRAPPING is ON, the source file is initially located [in cmake/FesapiJavaExample.java](./cmake/FesapiJavaExample.java))
62
-
- Python3 (no support for Python2) : [in python/example/example.py](./python/example/example.py)(please follow instructions in the documentation header of this examplepython file)
62
+
- Python3 (no support for Python2) : [in python/example/example.py](./python/example/example.py)or as a jupyter notebook [in python/example/fesapi.ipynb](./python/example/fesapi.ipynb)
63
63
64
64
You can also find Doxygen generated documentation [here](https://f2i-consulting.com/fesapi/doxygen/)
65
65
66
66
# Testing
67
67
This software was tested with :
68
68
- Catch2 from [Catch Org](https://github.com/catchorg/Catch2)
0 commit comments