Skip to content

Commit

Permalink
wip: Add basic usage docs to README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
mstenta committed Mar 14, 2024
1 parent c6d4166 commit d42db3a
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,41 @@

Provides features for crop planning in [farmOS](https://farmOS.org).

## Usage

1. Install the module.
2. Create a new Crop plan.
1. Go to Plans > Crop in the main menu, then click "Add Crop Plan".
2. Give the plan a name (eg: "2024 Beans").
3. Optionally add additional metadata (Season, Notes, Flags, etc).
4. Click "Save".
3. Populate the plan with crop plantings.
- Manually:
- Create new Plant assets:
1. ...
- Add existing Plant assets:
1. ...
- CSV import:
1. ...
4. View/update the plan during the season.
1. Go to Plans > Crop in the main menu.
2. Click on the name of the crop plan.
3. Visualize the planting timeline.
- ...
4. Update planting details.
- Manually:
1. ...
- CSV import:
1. ...
5. Archive the plan at the end of the season.
1. Go to Plans > Crop in the main menu.
2. Click the checkbox next to the plan.
3. Select "Archive plan" from the "Action" dropdown, and click "Apply to
selected items".

Archived plans can be viewed using the "Filter" options at the top of the list
of plans.

## Maintainers

Current maintainers:
Expand Down

0 comments on commit d42db3a

Please sign in to comment.