Skip to content

Commit 6309181

Browse files
committed
docs: fixed grammar errors (many thanks lucie).
1 parent cdb0058 commit 6309181

File tree

3 files changed

+30
-32
lines changed

3 files changed

+30
-32
lines changed

Readme.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ Version: 2.0
99

1010
Introduction
1111
------------
12-
The Intel HEX file format widely used in microprocessors and microcontrollers
13-
area as the de-facto standard for representation of code for programming
14-
microelectronic devices.
12+
The Intel HEX file format is widely used in microprocessors and microcontrollers
13+
area as the de facto standard for code representation for microelectronic devices programming.
1514

1615
This work implements an **intelhex** Python library to read, write,
1716
create from scratch and manipulate data from HEX (also known as Intel HEX)
@@ -25,14 +24,14 @@ inspecting data, and ``hexmerge.py`` merges multiple HEX files into one.
2524

2625
License
2726
-------
28-
The code distributed under BSD license. See LICENSE.txt in sources archive.
27+
The code is distributed under BSD license. See LICENSE.txt in the sources archive.
2928

3029
In short: you can use IntelHex library in your project without any restrictions.
3130

3231
If you're using IntelHex library in your open-source project, or your company
3332
created freely available set of tools, utilities or sdk based on IntelHex
34-
library - please, send me email and tell something about your project.
35-
I'd like to add name of your project/company to page "Who Uses IntelHex".
33+
library, please send me an email and tell something about your project.
34+
I'd like to add the name of your project/company to page "Who Uses IntelHex".
3635

3736
Python 3 compatibility
3837
----------------------
@@ -75,7 +74,7 @@ Get code with git:
7574

7675
User manual
7776
-----------
78-
User manual for IntelHex available in the sources docs/manual/ directory.
77+
User manual for IntelHex is available in the sources docs/manual/ directory.
7978
You can browse User Manual online:
8079

8180
http://pythonhosted.org/IntelHex/

docs/manual/part1-1.txt

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
About
22
*****
3-
The Intel HEX file format widely used in microprocessors and microcontrollers
4-
area as the de-facto standard for representation of code for programming
5-
microelectronic devices.
3+
The Intel HEX file format is widely used in microprocessors and microcontrollers
4+
area as the de facto standard for code representation for microelectronic devices programming.
65

76
This work implements an **intelhex** Python library to read, write,
87
create from scratch and manipulate data from HEX (also known as Intel HEX)
@@ -13,7 +12,7 @@ to do basic tasks that utilize this library. The ``bin2hex.py`` script
1312
converts binary data to HEX, and the ``hex2bin.py`` works the other direction.
1413
``hex2dump.py`` converts data from HEX to a hexdump which is useful for
1514
inspecting data, and ``hexmerge.py`` merges multiple HEX files into one.
16-
In addition you can try to inspect differences between 2 HEX files with
15+
In addition you can try inspecting differences between two HEX files with
1716
``hexdiff.py`` utility which uses dump output similar to ``hex2dump.py``.
1817

1918
You can find IntelHex library on PyPI:
@@ -31,27 +30,27 @@ https://github.com/bialix/intelhex
3130

3231
Motivation
3332
~~~~~~~~~~
34-
This work was partially inspired by SRecord_ software in that moment
35-
when I've stuck with its limitations and unintuitive behavior.
33+
This work was partially inspired by SRecord_ software at the moment
34+
when I stuck with its limitations and unintuitive behavior.
3635

37-
So I've made this library and related tools which gives me
36+
So I've made this library and related tools which give me
3837
full control over data and HEX file creation.
3938
Not the best reason to start yet another project.
4039
But, as you probably know, nothing is better than scratch our own itches,
4140
especially if you want to re-implement something
4241
in your favorite programming language.
4342

44-
Over the years it turned out my small python library was very useful
45-
for many people, and allowed them not only create utilities to manipulate
46-
with HEX files, but also create custom bootloaders for their devices.
43+
Over the years it turned out that my small python library was very useful
44+
to many people, and allowed them not only to create utilities to manipulate
45+
with HEX files, but also to create custom bootloaders for their devices.
4746

48-
I started to write this library in 2005, and now 10 years later it's still
47+
I started writing this library in 2005, and now 10 years later it's still
4948
alive and useful to other developers. That keeps me working on improving
50-
this code, even though I don't work on embedding systems for some time.
49+
the code, even though I don't work on embedding systems for some time.
5150

52-
If you find IntelHex library useful - please, send me email
51+
If you find IntelHex library useful, please send me email
5352
and tell a bit about how you're using it and in which projects/areas.
54-
That not only satisfy my curiosity but also helps me to keep working
53+
That will not only satisfy my curiosity but also will help me to keep working
5554
on this project.
5655

5756
.. _SRecord: http://srecord.sourceforge.net/

docs/manual/part1-3.txt

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@ Installation
22
************
33

44
Note: some commands below have `sudo` as first word.
5-
It's required only on Linux or MacOSX.
6-
Omit that prefix if you're on Windows.
5+
It's required only on Linux or Mac OS X.
6+
Omit the prefix if you're on Windows.
77

88
Installing with pip
99
~~~~~~~~~~~~~~~~~~~
1010
If you just need IntelHex library installed as your
1111
system python library
1212
then it's better to use modern tool called ``pip``
1313
(http://www.pip-installer.org/en/latest/)
14-
to install with command:
14+
to install with the command:
1515

1616
sudo pip install intelhex
1717

18-
Latest versions of Python interpreter (like 2.7.9, or 3.4.x and later)
18+
The latest versions of Python interpreter (like 2.7.9, or 3.4.x and later)
1919
have pip in the standard installer/distribution.
2020

2121
The simplest way to check whether you have pip installed
@@ -32,7 +32,7 @@ and run it as
3232

3333
Download sources
3434
~~~~~~~~~~~~~~~~
35-
You can get archive with latest released code, docs and other files
35+
You can get archive with the latest released code, docs and other files
3636
from PyPI:
3737

3838
https://pypi.python.org/pypi/IntelHex
@@ -41,11 +41,11 @@ Also IntelHex may be downloaded from:
4141

4242
https://launchpad.net/intelhex/+download
4343

44-
You can get archive with unreleased code from GitHub page:
44+
You can get the archive with the unreleased code from GitHub page:
4545

4646
https://github.com/bialix/intelhex
4747

48-
Use corresponding menu item in the right-hand side bar on that page
48+
Use the corresponding menu item in the right-hand side bar on that page
4949
(e.g. "Download ZIP").
5050

5151

@@ -64,19 +64,19 @@ Install from sources
6464
~~~~~~~~~~~~~~~~~~~~
6565
IntelHex has got stadard setup.py installation script.
6666
Assuming Python is properly installed on your platform,
67-
installation should just require running the following command
67+
installation should require just running of the following command
6868
from the root directory of the sources::
6969

7070
sudo python setup.py install
7171

7272
This will install the intelhex package into your system's site-packages
7373
directory and place the helper scripts in your Python site-packages
74-
binaries directory. After that is done, any other Python scripts or modules
74+
binaries directory. Once it is done, any other Python scripts or modules
7575
should be able to import the package using::
7676

7777
>>> from intelhex import IntelHex
7878

79-
The scripts should be in your PATH so that they can be called from anywhere
79+
The scripts should be in your PATH so that they could be called from anywhere
8080
in the file system.
8181

8282
See the Python distutils website for more information, or try typing,
@@ -90,7 +90,7 @@ for helper scripts as hex2bin.py, bin2hex.py and other mentioned in this
9090
documentation (see section Convenience Scripts).
9191

9292
You can find these scripts in your python Script directory
93-
(usually `C:\\PythonXY\\Scripts`). You need either create batch file to run them,
93+
(usually `C:\\PythonXY\\Scripts`). You need either to create batch file to run them,
9494
or use Python interpreter:
9595

9696
python C:\\PythonXY\\Scripts\\hex2bin.py ...

0 commit comments

Comments
 (0)