Skip to content
This repository has been archived by the owner on Mar 8, 2024. It is now read-only.

Commit

Permalink
readme and setup update
Browse files Browse the repository at this point in the history
  • Loading branch information
mitshell committed Oct 6, 2017
1 parent 37fd607 commit 7588cd6
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 12 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ It is the glorious successor of [libmich](https://github.com/mitshell/libmich),
which was started 8 years ago and served well.


License
=======

The whole library is licensed under GPLv2 and is compatible with more recent version
of the GPL: all licensed files have an header making it self-explanatory.


Wiki
====

Pycrate has a growing [wiki](https://github.com/anssi-fr/pycrate/wiki).


Installation
============

Expand All @@ -26,7 +39,8 @@ Dependencies
------------

Currently none. Only the Python builtins and few internal modules of Python
(e.g. os, system, re) are required.
(e.g. os, system, re) are required for most of the features.
The pycrate_corenet part requires pysctp and CryptoMobile.


Automatic installation
Expand Down Expand Up @@ -62,13 +76,6 @@ python -m pycrate_asn1c.proc
```


License
=======

The whole library is licensed under GPLv2 and is compatible with more recent version
of the GPL: all licensed files have an header making it self-explanatory.


Contributing
============

Expand All @@ -78,8 +85,8 @@ Contact and support
As the unique developper of the library (yet), I am the only person to contact:
michau \[dot\] benoit \[at\] gmail \[dot\] com.
This library is free software, however, specific support requires time and may not
be always possible. In case you need specific support, please consider contributing
first.
be always possible. In case you need specific support, please consider also
contributing in one way or another.

In case you are using this library in any of your project and you find it useful,
do not hesitate to send me an email. It is always a pleasure to know where
Expand All @@ -98,7 +105,7 @@ Any patch or submission is always very welcome!
Other contributions
-------------------

In case you do not feel like a developer, you can still contribute in many ways:
In case you do not want to deep dive in the code, you can still contribute in many ways:
* highlighting specific issues in the inner-working of the library,
and opening an issue with concrete debugging information
* writing new test cases for more coverage (have a look at the *test/* directory)
Expand Down
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

setup(
name="pycrate",
version="0.1",
version="0.2",

#packages=find_packages(),
packages=["pycrate_core",
Expand Down Expand Up @@ -32,6 +32,7 @@
# only compiled .py modules are installed by default
package_data={
#'pycrate_asn1dir': ['*.asn', '*.json'],
'pycrate_corenet': ['AuC.db'],
},
#include_package_data=False,

Expand Down

0 comments on commit 7588cd6

Please sign in to comment.