<commit_before>IRMA: Incident Response & Malware Analysis 
------------------------------------------

IRMA is an asynchronous and customizable analysis system for suspicious files.
This repository is a subproject of IRMA and contains the source code for IRMA's
Probes, which are python-based application that host a single or multiple
analyzers. Thanks for checking it out.

Documentation
`````````````

All documentation is in the ``docs`` directory. If you are just getting
started, here is how we recommend you read the docs:

1. First, build the documentation with ``sphinx`` (in the ``docs`` directory,
   do ``make html``).
2. Next, open the documentation in your favorite web browser. The documentation
   is generated in ``_build/html``. You can open, for instance,
   ``_build/html/index.html`` as a starting point.
3. Go through the documentation.

We are trying to do your best to update the documentation regularly. If you
find any problems in the documentation, or think they should be clarified in
any way, please take 30 seconds to fill out a `ticket
<https://github.com/quarkslab/irma-probe/issues>`_.

Getting help
````````````

Join the #qb_irma channel on irc.freenode.net. Lots of helpful people hang out there.


Contribute to IRMA
``````````````````

IRMA is an ambitious project. Make yourself known on the #irma_qb channel on
irc.freenode.net. We will be please to greet you and to find a way to get you
involved in the project.<commit_msg>Add documentation badge for read the docs<commit_after>IRMA: Incident Response & Malware Analysis 
------------------------------------------

|docs|

IRMA is an asynchronous and customizable analysis system for suspicious files.
This repository is a subproject of IRMA and contains the source code for IRMA's
Probes, which are python-based application that host a single or multiple
analyzers. Thanks for checking it out.

Documentation
`````````````

All documentation is in the ``docs`` directory. If you are just getting
started, here is how we recommend you read the docs:

1. First, build the documentation with ``sphinx`` (in the ``docs`` directory,
   do ``make html``).
2. Next, open the documentation in your favorite web browser. The documentation
   is generated in ``_build/html``. You can open, for instance,
   ``_build/html/index.html`` as a starting point.
3. Go through the documentation.

We are trying to do your best to update the documentation regularly. If you
find any problems in the documentation, or think they should be clarified in
any way, please take 30 seconds to fill out a `ticket
<https://github.com/quarkslab/irma-probe/issues>`_.

Getting help
````````````

Join the #qb_irma channel on irc.freenode.net. Lots of helpful people hang out there.


Contribute to IRMA
``````````````````

IRMA is an ambitious project. Make yourself known on the #irma_qb channel on
irc.freenode.net. We will be please to greet you and to find a way to get you
involved in the project.


.. |docs| image:: https://readthedocs.org/projects/irma/badge/
    :alt: Documentation Status
    :scale: 100%
    :target: https://irma.readthedocs.org
{'fraction_non_alphanumeric': 0.11727010573534123, 'fraction_numerical': 0.004165331624479333, 'mean_word_length': 3.7374810318664644, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2293641', 'n_tokens_mistral': 893, 'n_tokens_neox': 830, 'n_words': 426}