~george-edison55/qenet/0.1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
==========================================
 QENet - Qt Classes for the ENet Library.
      Copyright 2012 - Nathan Osman
==========================================

1. Building QENet on Unix-based Operating Systems

 QENet has two requirements:
 
  - ENet 1.3.3+
  - Qt 4.7+
 
 (Note: these are the minimum supported versions - earlier versions may work but
 there is no guarantee that they will.)
 
 In the root directory of the source archive, run the following commands:
 
   qmake
   make
   make install
  
  To run the unit tests, execute the following command:
  
   bin/qenet-tests

2. Generating Documentation

 QENet uses Doxygen <http://www.stack.nl/~dimitri/doxygen/> for generating
 documentation from special comments in the header files. Simply run the
 'doxygen' command in the root directory of the source archive to generate the
 HTML docs. They will be placed in 'docs/html' after being generated.