<commit_before># Introduction

This repository consists of a list of directories, each intended to be copied on
top of the standard contents of a /=base= desk. These examples are divided
between [dojo generators](dojo), [libraries](libs), [ford pages](ford), and
[applications](gall). See local readmes for more information.

# Trying an example

An individual example can be copied to your ship.
```shell
> |merge /=examples= /=base=
> /=examples=
> |mount %
$ cp -r $example-type/$samp/ $pier/examples/
```

The dojo commands above initialize a `/=examples=` desk from your
`/=base=`(default distibution desk), direct :dojo to use it as the working
directory, and mount it to unix as __pier__/examples. Then, in unix, __samp__
contents are added to the base files.

# Sync over `%clay`

A live copy of all everything is also maintained at ~sampel-someship(XX). By
running `|sync /=examples= /~sampel-somehip/examples=`, a local copy of the
`%examples` desk will be created and automatically updated with any
changes/additions.

As above, `/=examples=` will allow app/generator examples to be run: a short
form of `=dir /=examples=`, it sets the working `dir` to the `%example` desk 
(`=`en interpolate the current ship and time).

(the ~sampel-someship mirror is maintained by running
`$ cp -r examples/*/*/ pier/examples/` as a commit hook; doing so locally will
produce equivalent results at any given version.)

# "Hello world" example

The [hello](tree/master/hello) example is a simple generator that returns
`%hello-world`.

In the `:dojo>` prompt(accessible by pressing `^X` repeatedly if you happen to have found yourself in e.g. talk)
```hoon
> |sync /=examples= /~sampel-someship/examples=
activated sync from %examples on ~sampel-someship to %examples
sync succeeded from %examples on ~sampel-someship to %examples
> /=examples=<commit_msg>launched sample ship<commit_after># Introduction

This repository consists of a list of directories, each intended to be copied on
top of the standard contents of a /=base= desk. These examples are divided
between [dojo generators](dojo), [libraries](libs), [ford pages](ford), and
[applications](gall). See local readmes for more information.

# Trying an example

An individual example can be copied to your ship.
```shell
> |merge /=examples= /=base=
> /=examples=
> |mount %
$ cp -r $example-type/$samp/ $pier/examples/
```

The dojo commands above initialize a `/=examples=` desk from your
`/=base=`(default distibution desk), direct :dojo to use it as the working
directory, and mount it to unix as __pier__/examples. Then, in unix, __samp__
contents are added to the base files.

# Sync over `%clay`

A live copy of all everything is also maintained at ~wactex-ribmex. By
running `|sync /=examples= /~wactex-ribmex/examples=`, a local copy of the
`%examples` desk will be created and automatically updated with any
changes/additions.

As above, `/=examples=` will allow app/generator examples to be run: a short
form of `=dir /=examples=`, it sets the working `dir` to the `%example` desk 
(`=`en interpolate the current ship and time).

(the ~wactex-ribmex mirror is maintained by running
`$ cp -r ~/examples/*/*/ wactex-ribmex/examples/` as a commit hook; doing so locally will
produce equivalent results at any given version.)

# "Hello world" example

The [hello](tree/master/hello) example is a simple generator that returns
`%hello-world`.

In the `:dojo>` prompt(accessible by pressing `^X` repeatedly if you happen to have found yourself in e.g. talk)
```hoon
> |sync /=examples= /~wactex-ribmex/examples=
activated sync from %examples on ~wactex-ribmex to %examples
sync succeeded from %examples on ~wactex-ribmex to %examples
> /=examples=
{'fraction_non_alphanumeric': 0.10919385279050957, 'fraction_numerical': 0.0, 'mean_word_length': 4.66412213740458, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 15, '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': '1283976', 'n_tokens_mistral': 1178, 'n_tokens_neox': 1108, 'n_words': 501}