Skip to content

Commit

Permalink
Added separate pypi readme for publishing on Pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
ducktec committed Dec 11, 2018
1 parent c9bd3f3 commit efcdf31
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
9 changes: 9 additions & 0 deletions README_PYPI.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# PyDTNsim

## Introduction

This python module contains a simulation environment that allows the simulation of arbitrary Delay Tolerant Networking (DTN) scenarios on a packet (DTN terminology: bundle) level. *PyDTNsim* provides users with the ability to evaluate the performance of various routing approaches and to detect possibly occurring overload situations. Currently, the focus lies on deterministic Contact-Graph-based routing approaches, but there might be other
approaches available in the future. The clear modularization allows users to easily implement routing approaches on their own.

## More Information
Please refer to the Github repository for a more detailed overview of the module and tutorials on how to get started.
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from setuptools import setup

# Read the README as long description (used with pypi)
with open("README.md", "r") as fh:
with open("README_PYPI.md", "r") as fh:
long_description = fh.read()

setup(
Expand All @@ -16,7 +16,7 @@
long_description=long_description,
long_description_content_type="text/markdown",
license='MIT',
keywords="dtn, cgr",
keywords="delay-tolerant-networking, routing, simulation, dtn, cgr",
url="https://github.com/ducktec/pydtnsim",
python_requires='>=3.7.0',
packages=setuptools.find_packages(),
Expand Down

0 comments on commit efcdf31

Please sign in to comment.