Skip to content

Commit d8b3365

Browse files
committed
Better format for README.rst
1 parent 29f8dd3 commit d8b3365

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

README.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@ javaobj-py3
1717
:target: https://coveralls.io/r/tcalmant/python-javaobj?branch=master
1818
:alt: Coveralls status
1919

20-
python-javaobj is a python library that provides functions for reading and
20+
*python-javaobj* is a python library that provides functions for reading and
2121
writing (writing is WIP currently) Java objects serialized or will be
22-
deserialized by _ObjectOutputStream_. This form of object representation is a
22+
deserialized by ``ObjectOutputStream``. This form of object representation is a
2323
standard data interchange format in Java world.
2424

25-
javaobj module exposes an API familiar to users of the standard library
26-
marshal, pickle and json modules.
25+
The ``javaobj`` module exposes an API familiar to users of the standard library
26+
``marshal``, ``pickle`` and ``json`` modules.
2727

2828
About this repository
2929
=====================
3030

31-
This project is a fork of python-javaobj by Volodymyr Buell, originally from
31+
This project is a fork of *python-javaobj* by Volodymyr Buell, originally from
3232
`Google Code <http://code.google.com/p/python-javaobj/>`_ and now hosted on
3333
`GitHub <https://github.com/vbuell/python-javaobj>`_.
3434

@@ -41,14 +41,14 @@ Features
4141
* Java classes unmarshaling
4242
* Primitive values unmarshaling
4343
* Automatic conversion of Java Collections to python ones
44-
(_HashMap_ => dict, _ArrayList_ => list, etc)
44+
(``HashMap`` => ``dict``, ``ArrayList`` => ``list``, etc.)
4545

4646
Requirements
4747
============
4848

4949
* Python >= 2.7 or Python >= 3.2
5050
* Maven 2+ (for building test data of serialized objects.
51-
You can skip it if you do not plan to run tests.py)
51+
You can skip it if you do not plan to run ``tests.py``)
5252

5353
Usage
5454
=====

0 commit comments

Comments
 (0)