diff --git a/README.md b/README.md index b91313a85a60ec5e89236496e48de6011eca350b..8eb164134729b4d5781fd4bf52b5b8f2a55285c3 100644 --- a/README.md +++ b/README.md @@ -76,10 +76,12 @@ eisgenerator_plot --model="r{1e3}-r{100}c{1e-6}" --omega=1-1e6 --log --omegastep Generates Nyquist plot of model specified, allows the usage of the same flags as eisgenerator_export +### Linking + +it is best to link to this library with the help of [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) as this provides platform a agnostic to query for paths and flags. Almost certenly, pkg-config is already integrated into your buildsystem. + ## Python bindings -python bindings can be build separately from: [eisgeneratorpy](https://git-ce.rwth-aachen.de/carl_philipp.klemm/eisgeneraorpy) +python bindings can be build separately from: [eisgeneratorpy](https://github.com/IMbackK/eisgeneratorpy) -### Linking -it is best to link to this library with the help of [pkg-config](https://www.freedesktop.org/wiki/Software/pkg-config/) as this provides platform a agnostic to query for paths and flags. Almost certenly, pkg-config is already integrated into your buildsystem. diff --git a/doc/mainpage.md.in b/doc/mainpage.md.in index 8e3d70a4b947efcc592ebc0189820b14357bae91..fa7a04485a5994014547a057440731d483d88a43 100644 --- a/doc/mainpage.md.in +++ b/doc/mainpage.md.in @@ -1,6 +1,6 @@ \mainpage @PROJECT_NAME@ manual -**@PROJECT_NAME@** is a C++ shared library (lib@PROJECT_NAME@.so) and CLI application that allows one to generate EIS spectra with high performance. The target application is generating test and example datasets for machine learning applications. @PROJECT_NAME@'s development and target platform is GNU/Linux, but besides a c++20 compiler and libstd++ it has no dependencies and should compile on nigh any platform. @PROJECT_NAME@ also has python bindings, not described here, but note that using these erases a lot of the performance benefit of using this library. For information on how to build this library please look at the \ref README +**@PROJECT_NAME@** is a C++ shared library (lib@PROJECT_NAME@.so) and CLI application that allows one to generate EIS spectra with high performance. The target application is generating test and example datasets for machine learning applications. @PROJECT_NAME@'s development and target platform is GNU/Linux, but besides a c++20 compiler and libstd++ it has no dependencies and should compile on nigh any platform. @PROJECT_NAME@ also has python bindings, described [here](https://github.com/IMbackK/eisgeneratorpy), but note that using these erases a lot of the performance benefit of using this library. For information on how to build this library please look at the \ref README for an example on how to use the library see example tab above, for API documentation start here: * eis::Model