~glyph/spore

8dfedcaee4f21cbc71496d393cb2598b32040a7b — mycognosist 5 months ago
Initial commit with basic README
1 files changed, 41 insertions(+), 0 deletions(-)

A README.md
A  => README.md +41 -0
@@ 1,41 @@
# spore

A manual for the mycelial arts.

## Overview

`spore` is intended to serve as a reference manual for the cultivation of mycelium and mushrooms. Contents will include substrate recipes, techniques and processes - with an emphasis on clear instructions, low-tech approaches and proven methodologies.

Further goals of the `spore` project are to allow for offline-first viewing of the contained information in multi-formats, such as PDF and a locally-deployed website. It is our sincere hope that this manual will serve numerous individuals, collectives and communities on their co-creative journeys with fungi.

## Technical Details

The contents of `spore` are written in Markdown and presented as a digital manual in the form of a website. This format allows ease of navigation and searchability. `spore` uses [mdBook](https://github.com/rust-lang/mdBook), a software utility written in the [Rust programming language](https://www.rust-lang.org/), to create the digital manual.

## Usage

Clone this repository to your computer:

`git clone https://git.sr.ht/~glyph/spore`

Move into the `spore` directory:

`cd spore`

Serve a digital version of the manual on your computer:

`mdbook serve`

Or, build a binary of the manual which can be run as an executable:

`mdbook build`

See the [mdBook User Guide](https://rust-lang.github.io/mdBook/) for further information.

## Contact

You are warmly invited to contact `glyph` on `glyph@mycelial.technology` or in the Scuttleverse (`@HEqy940T6uB+T+d9Jaa58aNfRzLx9eRWqkZljBmnkmk=.ed25519`) if you have any questions or would like to contribute to the project.

## License

[CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/)