<commit_before>Usage

Enter the environment with the plugin.

```
nix-shell
```

(This will take a while (1-2 hours) as it will build GHC).

To use the plugin.

```
ghc -fplugin KythePlugin -fplugin-opt KythePlugin:logs T.hs
./serve logs/ localhost:8080
```

Then access localhost:8080 in order to view the cross linked source.


<commit_msg>Note about examples<commit_after># Usage

Enter the environment with the plugin.

```
nix-shell
```

(This will take a while (1-2 hours) as it will build GHC).

To use the plugin.

```
ghc -fplugin KythePlugin -fplugin-opt KythePlugin:logs T.hs
./serve logs/ localhost:8080
```

Then access localhost:8080 in order to view the cross linked source.


# Examples

There are also some examples which can be rendered if kythe is installed.

```
./serve examples/ localhost:8080
```

Will render the output for 5 simple files from two projects.
{'fraction_non_alphanumeric': 0.09534619750283768, 'fraction_numerical': 0.028376844494892167, 'mean_word_length': 3.9, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, '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': '551288', 'n_tokens_mistral': 303, 'n_tokens_neox': 265, 'n_words': 119}