binary1248 / SFNUL

Simple and Fast Network Utility Library
Mozilla Public License 2.0
52 stars 4 forks source link

SFNUL Simple and Fast Network Utility library

© binary1248 SFNUL is provided under the Mozilla Public License Version 2.0 (see LICENSE for details)

  1. INSTALLING

SFNUL requires a compiler with C++11 support. Not all features are used, however many newer features are used that might not be supported by all compilers even though they claim C++11 support. Your mileage may vary.

Dependencies:

The build system in use is CMake (http://cmake.org/). It's available for all major platforms.

To build, perform the following steps:

  1. USING SFNUL IN OWN PROJECTS

To use SFNUL in your projects, you have to link to the SFNUL library (see 1. for building). Also make sure that your compiler is able to find SFNUL's include directory.

If you're using CMake for your project and you've properly installed SFNUL (see 1.), you can automate the process of finding SFNUL. At first copy the file cmake/FindSFNUL.cmake to your CMake's module directory. Then add the following to your project's CMakeLists.txt file:

find_package( SFNUL REQUIRED ) include_directories( ${SFNUL_INCLUDE_DIR} ) add_executable( my_program ... ) target_link_libraries( my_program ... ${SFNUL_LIBRARY} )

In case CMake can't find your SFNUL installation, you can still specify the path manually by setting the SFNUL_ROOT CMake variable.

Because SFNUL makes use of the operating system's networking subsystem, be sure to link the necessary networking libraries to your final application as well.

  1. DOCUMENTATION

You can find the API documentation in the doc sub-directory. Create it with Doxygen (http://www.stack.nl/~dimitri/doxygen/).

  1. CONTACT

The AUTHORS file lists contributors with contact information.