# Intro

Sneed is a TOML-based, automatic farm generator. It can be used for planning your farm or garden's planting scheme simply by providing information.

## Workflow

How I use this tool is by buying seeds, reading the back of them to obtain row and seed-spacing information, putting them in a toml file, then running the `sneed` command on the toml file. 

This tool assumes you are using rows for your gardens.


## Usage Examples

### Seeing output
`sneed ./contrib/example.toml`

### Saving to a file
`sneed ./contrib/example.toml > sneed.txt`

## TOML File

The TOML file is very simple:

### X

X defines the "length" of the farm. 

### Y

Y defines the "width" of the farm.

### plants

#### soilicon

The ASCII icon used to represent raised soil.

#### gapicon

The ASCII icon used to represent a gap for walking inbetween rows.

#### gapsize

How many units the gap should be wide. For example, by setting 12 units as the gap size, I am given 12 characters of the gapicon inbetween rows.

#### farmableEdge

If set to true, then the program will assume that your plants are allowed to move into the edge of your farm. This is useful if you put viney plants on the edge of your farm (such as Watermelon) and want said plants to expand outward.

Internally, this makes it so that the plants planted on the edge (the ones first and last in your TOML file) have their row space divided by two.

### plants.entry

Plan entries represent the specific plants you desire to plant.

#### icon

The ASCII icon used to represent a plant.

#### seedspacing

The amount of units inbetween each seed within a row.

#### rowspacing

The amount of units wide that a row will be.

#### rownum

The amount of rows of a plant the program should create. Currently unused.