Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 2.41 KB

README.md

File metadata and controls

42 lines (24 loc) · 2.41 KB

PcapPlusPlus Logo

PcapPlusPlus is a multiplatform C++ library for capturing, parsing and crafting of network packets. It is designed to be efficient, powerful and easy to use.

PcapPlusPlus enables decoding and forging capabilities for a large variety of network protocols. It also provides easy to use C++ wrappers for the most popular packet processing engines such as libpcap, WinPcap, DPDK and PF_RING.

This repo contains the content for PcapPlusPlus web-site.

The project itself can be found here: https://github.com/seladb/PcapPlusPlus

Getting Started

Prerequisites

  1. Git
  2. Jekyll

Running locally

  1. Clone this repo: git clone https://github.com/PcapPlusPlus/pcapplusplus.github.io.git
  2. Run the web-site using Bundler: bundle exec jekyll serve
  3. Browse to http://localhost:4000

Overview

This web-site is built using Jekyll and uses Just The Docs theme for most of its content.

The API reference is generated using Doxygen. The Doxygen files are located under the /api-docs/doxygen directory and include the Doxyfile file and mainpage.dox which is the API main page.

Most of the content is organized in Markdown (.md) files which are easy to generate and maintain. The only exceptions are the API reference pages (which are generated using Doxygen) and the Landing Page (index.html).

Contribute

You are more than welcome to contribute to this web-site. You can do that by either opening issues on GitHub or by adding/modifying content and create a PR.

If you don't have a GitHub user you can also contact us by email: mailto:pcapplusplus@gmail.com

If you decide to create a PR please make sure you:

  • Run the changes locally to make sure they're working. Please refer to the Getting Started section to learn how
  • Test the changes on different browsers
  • Test the changes on both desktop and mobile. You don't really have to run it on a mobile device, each desktop browser offers a mobile view of the page