Skip to content

Commit

Permalink
Cleanup references to sharedlibpp
Browse files Browse the repository at this point in the history
  • Loading branch information
traversaro authored Nov 3, 2024
1 parent aaa4b17 commit ee238df
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 22 deletions.
33 changes: 12 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Simple cross platform plug-in system
====================================

The sharedlibpp is a tiny cross-platform library to create and load shared
libraries for different platform (Linux/Mac/Windows). The sharedlibpp provide
`shlibpp` is a tiny cross-platform library to create and load shared
libraries for different platform (Linux/Mac/Windows). `shlibpp` provides
an easy and portable way to create plug-ins which encapsulate your c++ classes
inside a shared library (so, dylib, dll).
The original code is taken and from
Expand All @@ -13,33 +13,24 @@ added to report the native OS error messages on failures.

Building on Linux/Mac
---------------------
$ cd sharedlibpp
$ mkdir build; cd build
$ cmake ../; make
$ cd shlibpp
$ cmake -Bbuild -S. -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=./install
$ cmake --build . --config Release
$ cmake --install .


Building on Windows
-------------------
The easiest way is to use Cmake to create VStudio project. To do that:

* download and install [cmake](http://www.cmake.org/download/) for windows.
* open the cmake gui and set the source path to `sharedlibpp` and set the
build path (for example `sharedlibpp/build`).
* configure and generate visual studio project.
* open the project and built it.

Running example
---------------
The build system by defualt compiles and build the examples.
The build system by default compiles and build the examples.

* On Linux/Mac
```
$ cd sharedlibpp/build/examples
$ ./math_test mymath.so
$ ./math_test_custom mymathcustom.so
$ cd shlibpp/build/examples
$ ./math_test mymath
$ ./math_test_custom mymathcustom
```
* On Windows first switch to directory where example is created and then
```
> math_test mymath.dll
> math_test_custom mymathcustom.dll
> math_test mymath
> math_test_custom mymathcustom
```
2 changes: 1 addition & 1 deletion pixi.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "sharedlibpp"
name = "shlibpp"
# As this version is currently ignored, we do not
# waste effort in mantain it in synch with the value
# specified in CMakeLists.txt
Expand Down

0 comments on commit ee238df

Please sign in to comment.