<commit_before># HFAM

<b>H</b>idden <b>F</b>iles <b>A</b>re <b>M</b>anageable - Manage, source and reload you dotfiles in a specific directory

1. You create/clone your `dotfiles` directory defined in `$HOME/`. 
2. You edit a `$HOME/dotfiles/.hfamconfig` with its intuitive DSL.
3. You call `hfam`.

The main advantage of this tool is that you can easily move your `dotfiles` from a machine to another one. Then, with only one command, you can configure your environment.

###Prerequisites

you need to install `ruby`:

```shell
?> \curl -sSL https://get.rvm.io | bash -s stable
?> rvm install ruby-head
```

Check if `ruby` is installed:

```shell
?> ruby --version
```

###Install

```shell
?> gem install hfam
```

I recommend you to put all your `dotfiles` in a Git repository named `dotfiles`.

clone your repo and add a file named `.hfamconfig`.

###Usage

Example

```asciidoc
~/
  |- dotfiles/
     |- gitconfig
     |- zshrc
     |- .hfamconfig
```

<commit_msg>feat(doc): update README.md<commit_after># HFAM

<b>H</b>idden <b>F</b>iles <b>A</b>re <b>M</b>anageable - Manage, source and reload you dotfiles in a specific directory

1. You create/clone your `dotfiles` directory defined in `$HOME/`. 
2. You edit a `$HOME/dotfiles/.hfamconfig` with its intuitive DSL.
3. You call `hfam`.

The main advantage of this tool is that you can easily move your `dotfiles` from a machine to another one. Then, with only one command, you can configure your environment.

###Prerequisites

you need to install `ruby`:

```shell
?> \curl -sSL https://get.rvm.io | bash -s stable
?> rvm install ruby-head
```

Check if `ruby` is installed:

```shell
?> ruby --version
```

###Install

```shell
?> gem install hfam
```

I recommend you to put all your `dotfiles` in a Git repository named `dotfiles`.

clone your repo and add a file named `.hfamconfig`.

###Usage

Example

```asciidoc
~/
  |- dotfiles/
     |- gitconfig
     |- zshrc
     |- .hfamconfig
```

###Options

Option `-h --help`

Display usage:

```shell
?> hfam --help

```

Option `-p --path`

```shell
?> hfam --path /Users/zoidberg/Documents/dotfiles
Symlink: ln -s /Users/mehdi/Documents/dotfiles/testpath /Users/zoidberg/Documents/.testpath
```

> The path set by --path option is the default symlink target path.
> use the DSL symlink option `:dest` to override this path.

{'fraction_non_alphanumeric': 0.1405982905982906, 'fraction_numerical': 0.002564102564102564, 'mean_word_length': 3.528046421663443, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 31, 'https://': 2, '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': '5841407', 'n_tokens_mistral': 837, 'n_tokens_neox': 785, 'n_words': 299}