<commit_before>========
pipes.sh
========

  *Animated pipes terminal screensaver.*

.. note on taking the screenshots

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 640x210. A sample command, where terminal at +0+18,
  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 640x210+$((2+2))+$((20+2)) -file doc/pipes.png

.. figure:: doc/pipes.png
  :target: screencast_

  Screenshot of pipes.sh, click to watch a screencast_ on YouTube.

.. _screencast: http://youtu.be/q_nYfR6CVEY

.. contents:: **Contents**
   :local:
   :backlinks: top


A Brief History
===============

pipes.sh was originally created by @msimpson and posted to the `Arch Linux Forums`_
in early 2010. It was also later posted to `Gist_` released in the public domain..

.. _Arch Linux Forums: https://bbs.archlinux.org/viewtopic.php?pid=728932#p728932
.. _Gist: https://gist.github.com/msimpson/1096939

In early 2013 @livibetter posted a modification of the script to Gist_ after reading
about it on a blog_ where it was maintained for a few months.

.. _Gist: https://gist.github.com/livibetter/4689307
.. _blog: http://inconsolation.wordpress.com/2013/02/01/pipes-sh-a-little-bit-of-fun/

In 2014 the script was given its own GitHub repo which encouraged contributions
from other developers. As the script gained more popularity the decision was made
to combine forces with developers of similar projects (such as this `C version`_).
Finally, in 2015 the MIT license was added and the Pipeseroni_ collective was formed.

.. _C version: Snakes_
.. _Pipeseroni: https://github.com/pipeseroni


Requirements
============

* Bash 4+ since version 1.0.0.


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

If you want to install, you can run:

.. code:: sh

  $ make install

By default, it installs to ``/usr/local``; for user home, you can run:

.. code:: sh

  $ make PREFIX=$HOME/.local install

Or any ``PREFIX`` you prefer.

The ``Makefile`` also provides ``uninstall`` target.


Options
=======<commit_msg>Add install instruction via Homebrew<commit_after>========
pipes.sh
========

  *Animated pipes terminal screensaver.*

.. note on taking the screenshots

  Font is Inconsolata, font size 24 as in 16x35 pixel per character

  Image size is 640x210. A sample command, where terminal at +0+18,
  window border is 2, terminal is urxvt, seems to 2 pixels as padding:

  xsnap -region 640x210+$((2+2))+$((20+2)) -file doc/pipes.png

.. figure:: doc/pipes.png
  :target: screencast_

  Screenshot of pipes.sh, click to watch a screencast_ on YouTube.

.. _screencast: http://youtu.be/q_nYfR6CVEY

.. contents:: **Contents**
   :local:
   :backlinks: top


A Brief History
===============

pipes.sh was originally created by @msimpson and posted to the `Arch Linux Forums`_
in early 2010. It was also later posted to `Gist_` released in the public domain..

.. _Arch Linux Forums: https://bbs.archlinux.org/viewtopic.php?pid=728932#p728932
.. _Gist: https://gist.github.com/msimpson/1096939

In early 2013 @livibetter posted a modification of the script to Gist_ after reading
about it on a blog_ where it was maintained for a few months.

.. _Gist: https://gist.github.com/livibetter/4689307
.. _blog: http://inconsolation.wordpress.com/2013/02/01/pipes-sh-a-little-bit-of-fun/

In 2014 the script was given its own GitHub repo which encouraged contributions
from other developers. As the script gained more popularity the decision was made
to combine forces with developers of similar projects (such as this `C version`_).
Finally, in 2015 the MIT license was added and the Pipeseroni_ collective was formed.

.. _C version: Snakes_
.. _Pipeseroni: https://github.com/pipeseroni


Requirements
============

* Bash 4+ since version 1.0.0.


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

If you want to install, you can run:

.. code:: sh

  $ make install

By default, it installs to ``/usr/local``; for user home, you can run:

.. code:: sh

  $ make PREFIX=$HOME/.local install

Or any ``PREFIX`` you prefer.

The ``Makefile`` also provides ``uninstall`` target.

If you are a `Homebrew <http://brew.sh>`_ user, you can install via:

.. code-block:: sh

    $ brew install pipes-sh


Options
=======
{'fraction_non_alphanumeric': 0.12559354226020894, 'fraction_numerical': 0.03941120607787275, 'mean_word_length': 3.859284890426759, 'pattern_counts': {'":': 0, '<': 4, '<?xml version=': 0, '>': 4, 'https://': 8, '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': '2786025', 'n_tokens_mistral': 1491, 'n_tokens_neox': 1311, 'n_words': 514}