Added readme.md

This is a simple description describing how to install. I will provide an install script for Linux and Windows in the future, but for now this is just so that there will be some documentation provided.
This commit is contained in:
Daniel Jones 2024-01-03 22:26:21 +00:00
parent 47e9e8e7a8
commit bdd60877a7

27
readme.md Normal file
View File

@ -0,0 +1,27 @@
# Daily Bread
## Get your daily bread with this program for Windows and Linux systems!
## Introduction
Daily Bread is a QT6 program designed to give you a new Bible verse every morning when you log into your computer!
## Installation
### Windows:
Double click the .bat file that comes with the Binary release to install.
Once it is finished running, Daily Bread should be included with your startup programs.
You can check your startup programs by pressing ctrl + alt + delete, clicking "show details" on the task manager, and then clicking "startup" tab.
### Linux:
These instructions will work for most Linux distrobutions
Download the Linux binary, and unzip it into a directory that you like. Run the following command:
```chmod +x install.sh```
Once you have run that command, install Daily Bread by typing in
```./install.sh```