diff --git a/Settings.md b/Settings.md new file mode 100644 index 0000000..d3dbe29 --- /dev/null +++ b/Settings.md @@ -0,0 +1,29 @@ +![Settings Image](https://raw.githubusercontent.com/CS-4820-Library-Project/Libly/master/images/SettingsHelp.PNG) + +## General + +**Show Debug Messages in Console Window:** Shows the verbose debug messages in the console window of the program. Useful for finding errors. + +## Reports + +**Yearly reports directory:** Location of where to save yearly reports, reports with 12 or less months + +**Other reports directory:** Default save location for non yearly reports, reports with more than 12 months. Reports saved here will not be incorporated into the database. + +**Report request interval:** The amount of time to wait between requesting reports from a vendor. Some vendors require us to wait before making another request. + +**Request timeout:** Amount of time to wait before cancelling a request for reports. + +**Concurrent Vendors:** The maximum number of vendors to work on at the same time, can impact PC performance. + +**Concurrent Reports:** The maximum number of reports to work on at the same time, can impact PC performance. + +**Empty Cell:** Empty cells retrieved in reports will be replaced by whatever text is entered here. + +## Costs + +**Default currency:** The currency shown first in the options in the Costs tab. This does not have to be one of the currencies in the default list. + +## Search + +**Rebuild Database:** Rebuilds the database from scratch based on the files in the "./all_data/.DO_NOT_MODIFY/" (hidden) directory. Also rebuild the costs in the database from the files in "./all_data/costs/" directory. Here "." is the directory the program is installed in. \ No newline at end of file