Skip to content

Commit

Permalink
Convert readme to restructured text
Browse files Browse the repository at this point in the history
  • Loading branch information
c-w committed Aug 12, 2018
1 parent a4a03b5 commit 332b4f7
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 6 deletions.
5 changes: 0 additions & 5 deletions README.md

This file was deleted.

35 changes: 35 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
mkwvconf
========

.. image:: https://api.travis-ci.org/ascoderu/mkwvconf.svg?branch=master
:target: https://travis-ci.org/ascoderu/mkwvconf

.. image:: https://img.shields.io/pypi/v/mkwvconf.svg
:target: https://pypi.org/project/mkwvconf/

Overview
--------

The :code:`mkwvconf.py` program is a tool that automatically generates a
`wvdial <https://linux.die.net/man/1/wvdial>`_ configuration for mobile
broadband devices using the `mobile-broadband-provider-info <https://github.com/GNOME/mobile-broadband-provider-info>`_ package.

This repo is a fork of mkwvconf modified to work on Python 2.7 and later. The
original mkwvconf can be found at `schuay/mkwvconf <https://github.com/schuay/mkwvconf>`_.

Usage
-----

First, install the tool and its system dependency:

.. sourcecode :: bash
python3 -m pip install mkwvconf
apt-get install mobile-broadband-provider-info
After installation, you can run tool to guide you through an interactive
setup experience that generates a wvdial configuration file for you:

.. sourcecode :: bash
mkwvconf.py
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
with open('version.txt') as fobj:
version = fobj.read().strip()

with open('README.md') as fobj:
with open('README.rst') as fobj:
long_description = fobj.read().strip()


Expand Down

0 comments on commit 332b4f7

Please sign in to comment.