Compare commits
No commits in common. "168f60562080bdeb00443cbeeb10d4f9cc043ced" and "43d8801e713b37794680bc2b4a32d690a48c3fce" have entirely different histories.
168f605620
...
43d8801e71
34
README.md
34
README.md
@ -1,16 +1,32 @@
|
||||
# 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).
|
||||
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).
|
||||
|
||||
|
||||
## building irrnet
|
||||
## Compiling for Linux
|
||||
|
||||
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).
|
||||
When cloning use the `--recurse-submodules` flag to retrieve the enet and zlib libraries needed by the project:
|
||||
|
||||
quick steps:
|
||||
`git clone --recurse-submodules https://github.com/rna88/irrnet.git`
|
||||
|
||||
1. clone the repository and pull the submodules: `git clone --recurse-submodules <path to repo>`
|
||||
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
|
||||
Then run `make` in the `source/` directory to build the library, which will be placed in `lib/`.
|
||||
|
||||
|
||||
## 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).
|
||||
|
Loading…
Reference in New Issue
Block a user