From 2e938af0968eccd5cac879a5406aa6836f338fdd Mon Sep 17 00:00:00 2001 From: Otto Naderer Date: Tue, 13 Dec 2022 01:32:47 +0100 Subject: [PATCH] updated readme --- README.md | 34 +++++++++------------------------- 1 file changed, 9 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8fbf8eb..798a06a 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,16 @@ -## Irrnet +# irrnet -An updated version of the [irrNetLite](http://irrlicht.sourceforge.net/forum/viewtopic.php?f=6&t=22658) networking library compiled against recent versions of [enet](https://github.com/lsalzman/enet) and [zlib](https://github.com/madler/zlib). - -Changelog can be viewed [here](https://github.com/rna88/irrnet/blob/master/CHANGELOG.md). +an updated version of the [irrNetLite](http://irrlicht.sourceforge.net/forum/viewtopic.php?f=6&t=22658) networking library compiled against recent versions of [enet](https://github.com/lsalzman/enet) and [zlib](https://github.com/madler/zlib). -## Compiling for Linux +## building irrnet -When cloning use the `--recurse-submodules` flag to retrieve the enet and zlib libraries needed by the project: +irrnet now uses an easy to use cmake configuration. use it to either build the lib or rather integrate it into your project's cmake setup (recommended). -`git clone --recurse-submodules https://github.com/rna88/irrnet.git` +quick steps: -Then run `make` in the `source/` directory to build the library, which will be placed in `lib/`. +1. clone the repository and pull the submodules: `git clone --recurse-submodules ` +1. use `cmake` or `cmake-gui` to generate makefiles or projects for your favorite ide. as for the first just do `cmake -B build` +1. on successful generation, cd into the just created `build` folder +1. `make` irrnet - -## Building examples - -Navigate to `examples/` and run: - -`./linux_buildAllExamples.sh` - -or to build them with optimizations: - -`./linux_buildAllExamples.sh release` - -The compiled binaries will be found in `examples/bin/`. - - -## License - -Refer to [source/ReadMe.txt](https://github.com/rna88/irrnet/blob/master/source/ReadMe.txt).