Moldy Bread

.. image:: https://github.com/markpbaggett/moldybread/workflows/Build%20and%20Test/badge.svg :alt: GitHub Build and Test Badge :width: 25%

.. image:: https://github.com/markpbaggett/moldybread/workflows/Release%20and%20Publish/badge.svg :alt: GitHub Release and Publish Badge :width: 25%

An attempt to reimplement whitebread <https://github.com/markpbaggett/whitebread/>_ in nim <https://nim-lang.org/>_.

.. image:: https://markpbaggett.github.io/moldybread/moldy.gif :alt: Harvesting Metadata with No Pages with Moldy Bread

Installing and Building

Installing the Release

Moldy Bread is designed to be as portable as possible by being compiled in C.

The latest tagged release is available in releases <https://github.com/markpbaggett/moldybread/releases>_ and compiled with gcc. Depending on your architecture (X86 64Bit Linux), you may be able to use the binary available here.

For security reasons, no authentication information is stored in the compiled version of the binary.

For this reason, you must point at a config.yml file. For more information about this, review the documentation <https://markpbaggett.github.io/moldybread/moldybread.html#defining-a-configdotyml>_.

Building the Application

If you are unable to use the release binrary, you can build a binary with the files in this repository.

1. First, follow the instructions here <https://nim-lang.org/install.html>_ to install nim. Using choosenim is recommended.
2. Make sure you set your PATH appropriately so that nim and nimble can be found.
3. Make sure you have a c compiler like gcc or musl (if not, you'll get an error in step 6).
4. git clone [email protected]:markpbaggett/moldybread.git
5. cd moldybread
6. nimble install

Documentation

Documentation for all packages and public procs and types are generated automatically and hosted in this repository with GitHub Pages <https://markpbaggett.github.io/moldybread/moldybread.html>_ after each commit.

Look here for instructions on how to use all operations.