Skip to content

Latest commit

 

History

History
150 lines (114 loc) · 7.9 KB

README.md

File metadata and controls

150 lines (114 loc) · 7.9 KB
Raw

Mom's Canning Timer
Mom's Canning Timer

Customizable 15-minute stove top timers, created for preserving fruits and veggies for the winter.

PyPI Build State Pytest State Pylint State CodeQL State GitHub Version GitHub Issues GitHub Pull Requests Discord Server ID Downloads GitHub Languages

Key Features • Download • How To Use • Support • Contributing • Changelog • Credits & Contributors

Key Features

  • Create 15 minute timers for cans.
  • Create multiple timers.
  • Rearrange timers to match stove top pattern.
  • Create multiple stove tops.
  • Easily update timer length.
  • Cross platform.

Download

You can download the source code to run the scripts from the command line on Windows, macOS and Linux. This will require Python.

You can download the latest executable version of Mom's Canning Timer for Windows. This does not require Python.

How To Use

To run the application, you can use Git and the Python Interpreter, which allows you to clone and run the application, or pip to create a command line application.

Git

To clone and run this application, you'll need Git and Python installed on your computer. If you would rather not use Git, you can just download the script from GitHub above. From your command line:

# Clone this repository
$ git clone https://github.com/Dog-Face-Development/Moms-Canning-Timer

# Go into the repository
$ cd Moms-Canning-Timer

# Run the CLI
$ python main.py

pip

You can install the program from the Python Package Index through pip.

# Install via pip
$ pip install moms-canning-timer

# Run the CLI
$ canning-timer

Support

Customization for Mom's Canning Timer can be found in the CUSTOMIZATION doc. More documentation is available in the Documentation and on the Wiki. If more support is required, please open a GitHub Discussion or join our Discord.

Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us (including how to sign our CLA).

Changelog

See the CHANGELOG file for details.

Credits

This software uses the following open source packages, projects, services or websites:

GitHub PSF PyInstaller Iconic
GitHub Python Software Foundation PyInstaller Open Iconic
Web - Plans Web - Donate Web - Donate Web

Contributors

You may also like...

  • ProgramVer - An open-source, Python GUI version window to show copyright info and licenses.
  • PyWorkout - A minimal CLI to keep you inspired during your workout!
  • PyAvatar - Easily display all of your creative avatars to keep them consistent across websites.

License

This project is licensed under the GNU General Public License - see the LICENSE file for details. See the Privacy Policy, Terms and Conditions, and EULA for legal information.