File: manual.txt

package info (click to toggle)
intelhex 2.3.0-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 460 kB
  • sloc: python: 3,200; makefile: 87; sh: 15
file content (60 lines) | stat: -rw-r--r-- 1,805 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
-----------------------------------
Python IntelHex Library User Manual
-----------------------------------

:Version: 2.3.0

.. contents::
.. sectnum::

Introduction
------------
.. include:: manual/part1-1.txt
.. include:: manual/part1-2.txt
.. include:: manual/part1-3.txt
.. include:: manual/part1-4.txt

Basic API and usage
-------------------
.. include:: manual/part2-1.txt
.. include:: manual/part2-2.txt
.. include:: manual/part2-3.txt
.. include:: manual/part2-4.txt
.. include:: manual/part2-5.txt
.. include:: manual/part2-6.txt
.. include:: manual/part2-7.txt
.. include:: manual/part2-8.txt

Convenience Scripts
-------------------
When IntelHex is installed and added to the system path, 
some scripts are available for usage. 
Each one is meant to be operated from the command line. 
They provide help if called incorrectly.

.. include:: manual/part3-1.txt
.. include:: manual/part3-2.txt
.. include:: manual/part3-3.txt
.. include:: manual/part3-4.txt
.. include:: manual/part3-5.txt
.. include:: manual/part3-6.txt

Embedding into other projects
*****************************
IntelHex should be easy to embed in other projects. 
The directory ``intelhex`` containing ``__init__.py`` can be directly placed 
in a depending project and used directly. From that project the same import 
statements described above can be used to make the library work. 
From other projects the import statement would change to::

    >>> from myproject.intelhex import IntelHex

Alternatively, the IntelHex package can be installed into the site-packages 
directory and used as a system package.

In either case, IntelHex is distributed with a BSD-style license. 
This permits you to use it in any way you see fit, provided that the package 
is appropriately credited.


.. include:: manual/appendix-a.txt