Skip to content

Commit

Permalink
Further rework the README file.
Browse files Browse the repository at this point in the history
  • Loading branch information
tanjeff committed Mar 4, 2016
1 parent 55f8afc commit 33d2a8a
Show file tree
Hide file tree
Showing 3 changed files with 136 additions and 100 deletions.
181 changes: 98 additions & 83 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
![agentXcpp Logo](artwork/github_logo.png)

About this README
=================

This README gives a short overview of the agentXcpp project, introduces the
repository's directory structure and describes how to build the documentation.
Further information can then be found in the documentation.

This README gives a short overview of the agentXcpp project and describes how
to build its documentation from source. It also introduces this repository's
directory structure.

About agentXcpp
===============

AgentXcpp is a C++ implementation of the AgentX protocol (RFC 2741).
What is agentXcpp ?
-------------------

The AgentX protocol is used to implement SNMP MIBs as subagents, which are
separate processes connecting to a master agent. The master agent in turn
provides a SNMP interface to the outside world.
AgentXcpp is a C++ implementation of the AgentX protocol (RFC 2741). The AgentX
protocol is used to implement SNMP MIBs as subagents, which are separate
processes connecting to a master agent. The master agent in turn provides an
SNMP interface to the outside world.

You may visit the project's website: [agentxcpp.org](http://agentxcpp.org)

Expand All @@ -28,12 +31,96 @@ Tables are also supported. Contexts (used by SNMPv3) are not yet supported.

Read the ChangeLog file to learn more.

License
-------

Copyright 2011-2016 Tanjeff-Nicolai Moos <tanjeff@cccmz.de>

This file is part of the agentXcpp library.

AgentXcpp is free software: you can redistribute it and/or modify
it under the terms of the AgentXcpp library license, version 1, which
consists of the GNU General Public License and some additional
permissions.

AgentXcpp is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

See the AgentXcpp library license in the LICENSE file of this package
for more details.

**IMPORTANT:** The software contained in the `site\_scons` directory is
distributed under its own license. See the files there for details.


The Documentation
=================


There are two types of documentation: The "API documentation" and the
"internals documentation".

The API documentation describes the AgentXcpp API and is intended for the user
of the library. It contains not only the complete API reference, but also a
tutorial to get started.

The internals documentation explains all internals of the library, including
descriptions of the used concepts, how the build system is configured and how
releases should be created. Of course, it contains also the reference of the
whole code.

The documentation is [published on the AgentXcpp
Homepage](http://agentxcpp.org), but it can also be build from source, which is
described in the following.



Directory Structure
===================

Building the Documentation
--------------------------

### Prerequisites

To build agentXcpp, the following is needed:

- Standard build environment (compiler, linker, etc.)
- The QT4 library (devel package, e.g. libqt4-dev on linux systems)
- Doxygen, to build the documentation
- The `dot` tool from the graphviz package, which is used by doxygen to
generate diagrams
- SCons, to control the build process
You can build the documentation using SCons or without SCons.

### Build Commands

1. With SCons:
cd into the `doc/` directory and type

scons

This builds both documentations (API and internal).

1. Without SCons:
cd into the `doc/` directory and type

doxygen api.doxyfile

respectively

doxygen internals.doxyfile

After building, the documentation can be displayed by pointing a web browser to
`doc/api/html/index.html` respectively `doc/internals/html/index.html`.

The top level directory contains the following elements:


Directory Structure of this Repository
======================================


This top level directory contains the following elements:

* __artwork/__

Expand Down Expand Up @@ -93,76 +180,4 @@ The top level directory contains the following elements:



Building the Documentation
==========================


Prerequisites
-------------

To build agentXcpp, the following is needed:

- Standard build environment (compiler, linker, etc.)
- The QT4 library (devel package, e.g. libqt4-dev on linux systems)
- Doxygen, to build the documentation
- The `dot` tool from the graphviz package, which is used by doxygen to
generate diagrams
- SCons, to control the build process


Building
--------

There are two types of HTML documentation: The "API documentation" and the
"internals documentation". The API documentation describes the AgentXcpp API
and is intended for the user of the library. The internals documentation is the
complete reference of the library, describing all internals.

You can build the documentation using SCons or without SCons.

1. With SCons:

cd to the top level directory (the one containing this README) and type

scons

This builds the library as well as both documentations.

1. Without SCons:
cd into the `doc/` directory and type

doxygen api.doxyfile

respectively

doxygen internals.doxyfile

These commands build only the corresponding documentation.

After building, the documentation can be displayed by pointing a web browser to
`doc/api/html/index.html` respectively `doc/internals/html/index.html`.


License
=======

Copyright 2011-2016 Tanjeff-Nicolai Moos <tanjeff@cccmz.de>

This file is part of the agentXcpp library.

AgentXcpp is free software: you can redistribute it and/or modify
it under the terms of the AgentXcpp library license, version 1, which
consists of the GNU General Public License and some additional
permissions.

AgentXcpp is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

See the AgentXcpp library license in the LICENSE file of this package
for more details.

IMPORTANT: The software contained in the site\_scons directory is distributed
under its own licence. See the files there for details.

Binary file added artwork/github_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
55 changes: 38 additions & 17 deletions artwork/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 33d2a8a

Please sign in to comment.