Skip to content

Commit

Permalink
Fix typos in README
Browse files Browse the repository at this point in the history
  • Loading branch information
otetard committed Jun 14, 2012
1 parent 2a21e8a commit 53dea31
Showing 1 changed file with 17 additions and 16 deletions.
33 changes: 17 additions & 16 deletions README.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[******************************************************************************]
[**********] [***********]
[**********] Netzob : inferring communication protocols [***********]
[**********] Netzob: inferring communication protocols [***********]
[**********] [***********]
[******************************************************************************]

Expand All @@ -13,8 +13,8 @@ Netzob simplifies the work for security auditors by providing a
complete framework for the reverse engineering of communication
protocols.

It handles different types of protocols : text protocols (like HTTP
and IRC), fixed fields protocols (like IP and TCP) and variable fields
It handles different types of protocols: text protocols (like HTTP and
IRC), fixed fields protocols (like IP and TCP) and variable fields
protocols (like ASN.1 based formats). Netzob is therefore suitable
for reversing network protocols, structured files and system and
process flows (IPC and communication with drivers). Netzob is provided
Expand All @@ -29,7 +29,7 @@ file, process and kernel data acquisition).
Netzob currently supports Linux x86 and x64 platforms. A Windows
version is expected soon.

Dependencies :
Dependencies:

* python
* python-ptrace
Expand All @@ -44,14 +44,15 @@ Dependencies :
* graphviz

Recommends:

* python-babel (used for translation)

Linux-specific dependencies :
Linux-specific dependencies:

* strace
* lsof

Or, on Debian-like operating systems :
Or, on Debian-like operating systems:

$ sudo apt-get install python python-ptrace python-matplotlib strace lsof \
python-pcapy python-bitarray python-dev python-lxml libjs-sphinxdoc \
Expand All @@ -75,13 +76,13 @@ $ ./netzob
[***********************] 4. Documentation [*************************]
[******************************************************************************]

Documentation generation :
Documentation generation:

The folder "doc/documentation" contains the documentation of Netzob in sphynx
format (.rst). Therefore, if you want to have updated HTMLs in the
"/doc/documentation/build/" directory based on the sources of the documentation
which is located in "/doc/documentation/source/" you'll have to execute the
following command :
following command:

$ sphinx-build -b html doc/documentation/source/ doc/documentation/build/

Expand All @@ -92,7 +93,7 @@ $ sphinx-build -b html doc/documentation/source/ doc/documentation/build/

** Requirements for Network and PCAP input **

Configuration :
Configuration:

$ sudo setcap cap_net_raw=ep /usr/bin/python2.XX

Expand All @@ -105,16 +106,16 @@ $ sudo bash -c "echo 0 > /proc/sys/kernel/yama/ptrace_scope"
[***********************] 6. Contact [*************************]
[******************************************************************************]

* Website : http://www.netzob.org
* Email : contact@netzob.org
* Mailing lists : https://lists.netzob.org/wws/
* Developer's room : https://dev.netzob.org
* IRC : #netzob on Freenode
* Website: http://www.netzob.org
* Email: contact@netzob.org
* Mailing lists: https://lists.netzob.org/wws/
* Developer's room: https://dev.netzob.org
* IRC: #netzob on Freenode

Authors:
* Georges Bossert
* Frédéric Guihéry

Sponsors:
* Amossys : http://www.amossys.fr
* Supélec : http://www.rennes.supelec.fr/ren/rd/cidre/
* AMOSSYS: http://www.amossys.fr
* Supélec: http://www.rennes.supelec.fr/ren/rd/cidre/

0 comments on commit 53dea31

Please sign in to comment.