Skip to content
This repository has been archived by the owner on Mar 23, 2023. It is now read-only.

Commit

Permalink
📖 Add README.
Browse files Browse the repository at this point in the history
Refs #1.
  • Loading branch information
jwir3 committed Dec 27, 2019
1 parent 416440c commit e372cd6
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 48 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<img src="assets/logo.svg" width="200" />

# Chronogrog
A tool for creating brewing production schedules

## Description
`chronogrog` is a tool for creating [Gantt charts](https://en.wikipedia.org/wiki/Gantt_chart) for brewery production schedules. The input is a [BPD (beer production description file)](#beer-production-description-file-format), which is a JSON file in a specific format (defined below).

The system is designed to be used with [pla](https://github.com/jwir3/pla), a tool for creating Gantt charts from a descriptive file format.

## Roadmap
Currently, the chronogrog tool converts a file from a beer production description format into the necessary format for pla to generate a Gantt chart. Currently, the following features are supported:

- Tracking of resources to support single usage of resources for a given point in time
- Templates for brewing phases to eliminate duplicated data as much as possible within the beer production description file.

Within our [issues listing](https://github.com/foamfactory/chronogrog/issues) there are a number of issues targeting new feature development. Eventually, we want to completely incorporate the pla tool within chronogrog. The concept is to be able to go from a beer production description file directly to a styleable Gantt chart, in html or svg format.

## Beer Production Description File Format
128 changes: 80 additions & 48 deletions assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e372cd6

Please sign in to comment.