Metadata-Version: 2.4
Name: pycrc
Version: 0.11.0
Summary: A free, easy to use Cyclic Redundancy Check source code generator for C/C++
Author-email: Thomas Pircher <tehpeh-web@tty1.net>
Project-URL: Homepage, https://pycrc.org
Project-URL: Bug Tracker, https://github.com/tpircher/pycrc/issues
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS
Requires-Dist: importlib-metadata>=4.0
Dynamic: license-file

pycrc
=====

[pycrc](https://pycrc.org) is a free, easy to use Cyclic Redundancy Check (CRC)
calculator and C source code generator.


System Requirements
-------------------

Python 3.8 or newer is required to run pycrc.
The last version compatible with Python 2 is v0.9.x.

Running pycrc
-------------

This program doesn't need to be installed to be run. The script can be
executed from the source directory.
Simply call the python interpreter with the script as parameter:

    python3 src/pycrc.py [options]

Installation
------------

Install pycrc (if required) using pip:

    python3 -m pip install pycrc

or apt (on Debian 13 and later, Ubuntu 23.10 and later, and
derivatives):

    sudo apt install pycrc

Either of these will install a `pycrc` binary in the path.


Getting help
------------

If you are new to pycrc and want to generate C code, start with
[the tutorial](https://pycrc.org/tutorial.html).

The [pycrc manual page](https://pycrc.org/pycrc.html) explains the command line
options in some detail and also gives some more examples how to use pycrc.

If you have found a bug in pycrc or want to request a feature please take the
time and submit it to the
[issue tracker](https://github.com/tpircher/pycrc/issues).
Thanks for your help.

Also see the [frequently asked questions](https://pycrc.org/faq.html).


Feedback
--------

If you like pycrc, let me know and drop me a note. If you don't like pycrc let
me know what you don't like and why.
If you want some idea how to say thanks for this software, please have a look
[here](https://www.tty1.net/say-thanks_en.html).


Copyright of the generated source code
--------------------------------------

The MIT licence allows commercial use of the source and the output of the
program. But since I got asked on occasion whether the generated code is
encumbered by the copyright of the author, I give my view on this:

The code generated by pycrc is not considered a substantial portion of the
software, therefore the licence does not cover the generated code; the
author of pycrc will not claim any copyright on the generated code.
