<commit_before>========
dotfiles
========

.. image:: https://github.com/jcfr/dotfiles/actions/workflows/shellcheck.yml/badge.svg
  :target: https://github.com/jcfr/dotfiles/actions/workflows/shellcheck.yml
  :alt: GitHub Actions

The organization of this project is based on the great work of `@jessfraz <https://github.com/jessfraz>`_.
See `here <https://github.com/jessfraz/dotfiles>`_ for the original project.

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

::

  $ git clone --recurse-submodules git://github.com/jcfr/dotfiles
  $ cd dotfiles
  $ make

This will create symlinks from this repo to your home folder.

::

  $ sudo ./aptfile

This will install packages like powerline, python, virtualenwrapper, ...


Customization
=============

Save env vars, etc in a ``.extra`` file, that looks something like
this::

  ###
  ### Customization
  ###
  PROMPT_USE_POWERLINE=false # Disable use of powerline (enabled by default)

  ###
  ### Git credentials
  ###

  GIT_AUTHOR_NAME="<NAME>"
  GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
  git config --global user.name "$GIT_AUTHOR_NAME"
  GIT_AUTHOR_EMAIL="<EMAIL>"
  GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
  git config --global user.email "$GIT_AUTHOR_EMAIL"
  GH_USER="nickname"
  git config --global github.user "$GH_USER"

Test
====

The tests use `shellcheck <https://github.com/koalaman/shellcheck>`_. You don't
need to install anything. They run in a container.

::

  $ make test
<commit_msg>README: Document how to ensure "powerline git status" shows up after install<commit_after>========
dotfiles
========

.. image:: https://github.com/jcfr/dotfiles/actions/workflows/shellcheck.yml/badge.svg
  :target: https://github.com/jcfr/dotfiles/actions/workflows/shellcheck.yml
  :alt: GitHub Actions

The organization of this project is based on the great work of `@jessfraz <https://github.com/jessfraz>`_.
See `here <https://github.com/jessfraz/dotfiles>`_ for the original project.

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

::

  $ git clone --recurse-submodules git://github.com/jcfr/dotfiles
  $ cd dotfiles
  $ make

This will create symlinks from this repo to your home folder.

::

  $ sudo ./aptfile

This will install packages like powerline, python, virtualenwrapper, ...


Customization
=============

Save env vars, etc in a ``.extra`` file, that looks something like
this::

  ###
  ### Customization
  ###
  PROMPT_USE_POWERLINE=false # Disable use of powerline (enabled by default)

  ###
  ### Git credentials
  ###

  GIT_AUTHOR_NAME="<NAME>"
  GIT_COMMITTER_NAME="$GIT_AUTHOR_NAME"
  git config --global user.name "$GIT_AUTHOR_NAME"
  GIT_AUTHOR_EMAIL="<EMAIL>"
  GIT_COMMITTER_EMAIL="$GIT_AUTHOR_EMAIL"
  git config --global user.email "$GIT_AUTHOR_EMAIL"
  GH_USER="nickname"
  git config --global github.user "$GH_USER"

Test
====

The tests use `shellcheck <https://github.com/koalaman/shellcheck>`_. You don't
need to install anything. They run in a container.

::

  $ make test


Troubleshoot
============

* Powerline git status does not show up. See `Reloading powerline after update <https://powerline.readthedocs.io/en/master/tips-and-tricks.html#reloading-powerline-after-update>`_

{'fraction_non_alphanumeric': 0.14732142857142858, 'fraction_numerical': 0.0, 'mean_word_length': 4.325976230899831, 'pattern_counts': {'":': 0, '<': 14, '<?xml version=': 0, '>': 14, 'https://': 11, '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': '1810725', 'n_tokens_mistral': 1086, 'n_tokens_neox': 1038, 'n_words': 271}