From 5c3b65cb44ab445c3e60963aedc707af39e9073c Mon Sep 17 00:00:00 2001 From: Alexander Belchenko Date: Tue, 30 Jan 2018 07:24:23 +0200 Subject: [PATCH] update readme again --- .bzrignore | 2 +- .gitignore | 1 + Readme.rst | 17 +++++++++++------ 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/.bzrignore b/.bzrignore index 13f81db..1f4abe3 100644 --- a/.bzrignore +++ b/.bzrignore @@ -15,4 +15,4 @@ wheelhouse ./.gitignore ./venv ./python.bat -./NEWS.html +./*.html diff --git a/.gitignore b/.gitignore index 345ca16..b2ec56f 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,4 @@ dist/ MANIFEST python.bat NEWS.html +README.html diff --git a/Readme.rst b/Readme.rst index a0db637..614c90b 100644 --- a/Readme.rst +++ b/Readme.rst @@ -7,7 +7,7 @@ The Intel HEX file format is widely used in microprocessors and microcontrollers area (embedded systems etc) as the de facto standard for representation of code to be programmed into microelectronic devices. -This work implements an **intelhex** Python library to read, write, +This work implements an ``intelhex`` Python library to read, write, create from scratch and manipulate data from Intel HEX file format. The distribution package also includes several convenience Python scripts, @@ -16,7 +16,8 @@ those based on the library itself. Check the docs to know more. License ------- -The code is distributed under BSD license, see LICENSE.rst. +The code is distributed under BSD license, +see `LICENSE.txt `_. In short: you can use IntelHex library in your project without *any* restrictions. @@ -34,18 +35,22 @@ Install using ``pip`` (recommended, no separate download required):: Download -------- -* https://pypi.python.org/pypi/IntelHex +* https://pypi.org/project/IntelHex/ * https://github.com/bialix/intelhex/releases Source code, bug reports, patches --------------------------------- IntelHex on GitHub: - https://github.com/bialix/intelhex +https://github.com/bialix/intelhex User manual ----------- -User manual for IntelHex is available in the sources docs/manual/ directory. +User manual for IntelHex is available in the sources ``docs/manual/`` directory. You can browse User Manual online: - https://readthedocs.org/projects/python-intelhex/ +https://readthedocs.org/projects/python-intelhex/ + +Changelog +--------- +See `NEWS.rst `_