Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 3.11 KB

README.md

File metadata and controls

83 lines (51 loc) · 3.11 KB

Duration Predictor (title subject to change)

Contributor Covenant

Better predict how much time does it take to complete recurring activities.

Problem

I have a terrible sense of how much time I spend on recurring activities, so I terribly distribute my time and miss commitments.

Goal

I want a tool that can better predict how much time to allow for an activity based on previous measurements.

Concepts

  • Activity: Any recurring task that you want to measure and better predict in the future.
  • Measurement: The User or the System measures the actual Duration it took to finish the Activity to make future predictions.

Getting Started

Prerequisites

To contribute to this project, you need the following programs:

If you do not have these tools, you can follow GHCup instructions to have them installed on your machine.

Running the wizard

To start the program, type cabal new-run duration-predictor in the Terminal in the project root. It will ask for information about a new Activity and its first Measurement.

Running the tests

This program is tested with the following versions:

Type cabal new-run test in the Terminal in the project root to run the tests.

Generating the documentation

To generate a local copy of this program's documentation, type cabal new-haddock. It will create an HTML website locally to see the documentation.

Built With

  • Haskell: The language used
  • Polysemy: Higher-order, low-boilerplate free monads
  • Tasty: Modern and extensible testing framework
  • Ormulo: A formatter for Haskell source code

Versioning

We use SemVer for versioning.

Author

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

  • Ram ❤️ for inspiring this project by displaying unwavering dilligence