Blame README.md

Packit ef9df4
# Convert::ASN1
Packit ef9df4
Packit ef9df4
Convert::ASN1 is a perl library for encoding/decoding data using
Packit ef9df4
ASN.1 definitions
Packit ef9df4
Packit ef9df4
The ASN.1 parser is not a complete implementation of the
Packit ef9df4
[ASN.1](http://www.itu.int/ITU-T/studygroups/com17/languages/X.680-0207.pdf)
Packit ef9df4
specification. It has been built over time and features have been
Packit ef9df4
added on an as-needed basis.
Packit ef9df4
Packit ef9df4
## Latest Release
Packit ef9df4
Packit ef9df4
The latest release can be found on http://www.cpan.org/ at
Packit ef9df4
http://search.cpan.org/dist/Convert-ASN1/
Packit ef9df4
Packit ef9df4
The documentation is at http://search.cpan.org/perldoc?Convert::ASN1
Packit ef9df4
Packit ef9df4
## Installing
Packit ef9df4
Packit ef9df4
Install with your favorite CPAN install manager, eg
Packit ef9df4
Packit ef9df4
    cpanm Convert::ASN1
Packit ef9df4
Packit ef9df4
If you do not have cpanm installed you can run
Packit ef9df4
Packit ef9df4
    curl -s -L http://cpanmin.us | perl - Convert::ASN1
Packit ef9df4
Packit ef9df4
## Contributing
Packit ef9df4
Packit ef9df4
### Git
Packit ef9df4
Packit ef9df4
The preferred method of contribution is by forking a repository on
Packit ef9df4
github.
Packit ef9df4
Packit ef9df4
If you are not familiar with working with forked repositories please
Packit ef9df4
read http://help.github.com/fork-a-repo/ for details on how to setup
Packit ef9df4
your fork.
Packit ef9df4
Packit ef9df4
Try to avoid submitting to the master branch in your fork, it is
Packit ef9df4
useful to keep that following the main repository and if I decide
Packit ef9df4
to cherry-pick or fixup any commit you submit in a pull request you
Packit ef9df4
will have tracking issues later
Packit ef9df4
Packit ef9df4
To start a branch for fixes do the following, assuming you have the
Packit ef9df4
origin and upstream remotes setup as in the guide linked to above.
Packit ef9df4
Packit ef9df4
    git fetch upstream git checkout -b mybranch upstream/master
Packit ef9df4
Packit ef9df4
this will checkout a new branch called _mybranch_ from the latest
Packit ef9df4
code the the master branch of the upstream repository.
Packit ef9df4
Packit ef9df4
Once you have finished push that branch to your origin repository
Packit ef9df4
with
Packit ef9df4
Packit ef9df4
    git push -u origin HEAD
Packit ef9df4
Packit ef9df4
The -u will setup branch tracking so if you later add more commits
Packit ef9df4
a simple
Packit ef9df4
Packit ef9df4
    git push
Packit ef9df4
Packit ef9df4
is enough to push those commits.
Packit ef9df4
Packit ef9df4
Once you have pushed the branch to github, send a pull as described
Packit ef9df4
at http://help.github.com/send-pull-requests/
Packit ef9df4
Packit ef9df4
### Dist::Zilla
Packit ef9df4
Packit ef9df4
The release is developed using
Packit ef9df4
[Dist::Zilla](http://search.cpan.org/perldoc?Dist::Zilla)
Packit ef9df4
Packit ef9df4
you will need to install
Packit ef9df4
Packit ef9df4
    cpanm Dist::Zilla
Packit ef9df4
Packit ef9df4
once you have the base install of Dist::Zilla run
Packit ef9df4
Packit ef9df4
    dzil authordeps --missing | cpanm dzil listdeps --missing | cpanm
Packit ef9df4
Packit ef9df4
### perl-byacc
Packit ef9df4
Packit ef9df4
If you need to make changes to the parser then you will need to
Packit ef9df4
build perl-byacc1.8.2. You can fetch the source from
Packit ef9df4
[perl-byacc1.8.2.tar.gz](http://www.cpan.org/src/misc/perl-byacc1.8.2.tar.gz)
Packit ef9df4
Packit ef9df4
With that built and available in your $PATH as byacc the parser can
Packit ef9df4
be compiled with
Packit ef9df4
Packit ef9df4
    perl mkparse parser.y lib/Convert/ASN1/parser.pm
Packit ef9df4
Packit ef9df4
## License
Packit ef9df4
Packit ef9df4
This software is copyright (c) 2000-2012 by Graham Barr.
Packit ef9df4
Packit ef9df4
This is free software; you can redistribute it and/or modify it under
Packit ef9df4
the same terms as the Perl 5 programming language system itself.
Packit ef9df4