From 4c256e7fcbcd66f5bf1df323bea081ceb1ca4052 Mon Sep 17 00:00:00 2001 From: Joe M Date: Thu, 1 Aug 2024 08:00:18 -0400 Subject: [PATCH] #83 added more sections to help plus about project section --- AboutProject/Forums.md | 10 ++++++ .../How to Download.md | 0 AboutProject/README.md | 8 +++++ AboutProject/issues.md | 11 ++++++ help/Condition_Types_Adding.md | 21 +++++++++++ help/Condition_Types_deleting.md | 15 ++++++++ help/Condition_Types_editing.md | 17 +++++++++ help/Copy_An_Accessory.md | 22 ++++++++++++ help/Copy_a_firearm.md | 35 +++++++++++++++++++ help/README.md | 2 +- help/backup_database.md | 21 +++++++++++ 11 files changed, 161 insertions(+), 1 deletion(-) create mode 100644 AboutProject/Forums.md rename How to Download.md => AboutProject/How to Download.md (100%) create mode 100644 AboutProject/README.md create mode 100644 AboutProject/issues.md create mode 100644 help/Condition_Types_Adding.md create mode 100644 help/Condition_Types_deleting.md create mode 100644 help/Condition_Types_editing.md create mode 100644 help/Copy_An_Accessory.md create mode 100644 help/Copy_a_firearm.md create mode 100644 help/backup_database.md diff --git a/AboutProject/Forums.md b/AboutProject/Forums.md new file mode 100644 index 0000000..faa7ad3 --- /dev/null +++ b/AboutProject/Forums.md @@ -0,0 +1,10 @@ +--- +sort: 3 +--- +# Forums + +Github Allows Sections in the Repository for Announcements and Discussions about the project. + +To participate in the Discussions Forum, you must be registered or sign-up with Github. + +To View the Discussions Forum [Click Here](https://github.com/burnsoftnet/MyGunCollection/discussions) diff --git a/How to Download.md b/AboutProject/How to Download.md similarity index 100% rename from How to Download.md rename to AboutProject/How to Download.md diff --git a/AboutProject/README.md b/AboutProject/README.md new file mode 100644 index 0000000..eea8431 --- /dev/null +++ b/AboutProject/README.md @@ -0,0 +1,8 @@ +--- +sort: 1 +--- +# About The Project + +This section will Just tell you about the project and where you can view the repo, issues, downloads and discussions. + +{% include list.liquid all=true %} diff --git a/AboutProject/issues.md b/AboutProject/issues.md new file mode 100644 index 0000000..828a2da --- /dev/null +++ b/AboutProject/issues.md @@ -0,0 +1,11 @@ +--- +sort: 2 +--- + +# View And Submit Issues + +The Issues Sections of the Project contains Bugs that was found and Future enhancements that is wanted in the application. + +To submit a but or request an issues you must be registered or sign-up with Github. + +To view the issues section [Click here](https://github.com/burnsoftnet/MyGunCollection/issues) \ No newline at end of file diff --git a/help/Condition_Types_Adding.md b/help/Condition_Types_Adding.md new file mode 100644 index 0000000..cf409e8 --- /dev/null +++ b/help/Condition_Types_Adding.md @@ -0,0 +1,21 @@ +# Adding Condition Types + +Since the release of the My Gun Collection version 5.x, you are now able to manage, edit or delete the Condition Types of a firearm. If you wish to edit the current information for the condition types, just click on "*Edit | Condition Types*" + +![](images/Conditions_Edit_Menu.jpg) + +Scroll down to the bottom on the list Till you get to the Last line with the * beside it. + +![](images/Conditions_Adding_Newatend.jpg) + +Double click on the whitespace, to start adding a new condition + +![](images/Conditions_Adding_DoubleclicktoAdd.jpg) + +Once you are done, hit your Enter key or click on the field above to save your new addition. + +![](images/Conditions_Adding_DoubleclicktoAdd_done.jpg) + +Now when you are editing or adding a new firearm, your new condition will be listed. + +![](images/Conditions_Add_UpdateForGunMenu.jpg) diff --git a/help/Condition_Types_deleting.md b/help/Condition_Types_deleting.md new file mode 100644 index 0000000..422828d --- /dev/null +++ b/help/Condition_Types_deleting.md @@ -0,0 +1,15 @@ +# Deleting Condition Types + +Since the release of the My Gun Collection version 5.x, you are now able to manage, edit or delete the Condition Types of a firearm. If you wish to edit the current information for the condition types, just click on "*Edit | Condition Types*" + +![](images/Conditions_Edit_Menu.jpg) + +Find the Condition that you wish to Delete and click on it once to select it. + +![](images/Conditions_Delete_Condition_select.jpg) + +now hit the Delete Key on the keyboard to delete the condition. + +![](images/Conditions_Delete_Condition_After.jpg) + +As you can see in the picture above, it is now gone. diff --git a/help/Condition_Types_editing.md b/help/Condition_Types_editing.md new file mode 100644 index 0000000..5a3bf75 --- /dev/null +++ b/help/Condition_Types_editing.md @@ -0,0 +1,17 @@ +# Editing Condition Types + +Since the release of the My Gun Collection version 5.x, you are now able to manage, edit or delete the Condition Types of a firearm. If you wish to edit the current information for the condition types, just click on "*Edit | Condition Types*" + +![](images/Conditions_Edit_Menu.jpg) + +Find the Condition that you wish to edit and double click on it to start editing. + +![](images/Conditions_Edit_DoublieClicktoedit.jpg) + +Once you are done making changes, just click on another field or hit your Enter key to save your changes. + +![](images/Conditions_Edit_DoublieClicktoedit_done.jpg) + +Now when you are editing or adding a firearm, you will see the changes made in the condition menu. + +![](images/Conditions_Edit_UpdateForGunMenu.jpg) diff --git a/help/Copy_An_Accessory.md b/help/Copy_An_Accessory.md new file mode 100644 index 0000000..38560fb --- /dev/null +++ b/help/Copy_An_Accessory.md @@ -0,0 +1,22 @@ +# Copying an Accessory + +As you already know, when you are view the details of a selected firearm, you can add Accessories that go with that firearm. From that same tab, you can now edit, copy and Delete items from that list. + +While viewing the Accessories section for the selected firearm, click on the item that you are interested in to highlight the row, then right click on your mouse to bring down the following menu: + +![](images/Accessories_Copy_Item_Selected.jpg) + +Select and Click on *Copy* to bring up the following window. + +![](images/Accessories_Copy_Item_Select_Firearm.jpg) + +Click on the Down arrow to view the list of firearms that are in your collection + +![](images/Accessories_Copy_Item_Select_Firearm_List.jpg) + +Once you have the firearm selected, click on the *Copy* button to continue. + +![](images/Accessories_Copy_Item_Select_Firearm_Completed.jpg) + +A Message box will appear stating that the item was copied successfully. From this window you can click on *No* to exit the form or you can click on *Yes* to copy it to another firearm. + diff --git a/help/Copy_a_firearm.md b/help/Copy_a_firearm.md new file mode 100644 index 0000000..b983dc2 --- /dev/null +++ b/help/Copy_a_firearm.md @@ -0,0 +1,35 @@ +# How to Copy a Firearm + +This section will tell you how to copy a firearm. Sometimes we may get another or newer version of a firearm that we have in our collection. Even though the specs for the firearm are pretty much the same, it is still a pain to fill out all the information again. So to help with this issue, we added the ability to copy the details of a previous firearm. + +At the Main screen, *Click* once to highlight the firearm that you wish to copy from the firearm list located on the left hand side.. + +Then *right click* on the selected firearm to bring up the following menu. + +![](images/CopyFirearm_CopyMenu.jpg) + +Click on *Copy Firearm* to bring up the following window: + +![](images/CopyFirearm_AddingInformation_1.jpg) + +As you can See this is the same as Clicking on the *Add Firearm* Button, except that it has copied all the information from the selected firearm to this new one. All you have to do now is Type in the Serial Number and change any other information that you feel needs to be changed. + +![](images/CopyFirearm_AddingInformation_2.jpg) + +Once you are finished adding or correcting information, click on the *Add Firearm to My Collection* button to add this firearm to the collection. + +![](images/CopyFirearm_Completed.jpg) + +**WARNING: When you copy a Firearm that has the Same Model name, it will appear Twice on the Side list on the Main Window.** + +![](images/CopyFirearm_Duplicatename_warning.jpg) + +This might cause issues if you had to quickly look up something and pull up the wrong firearm. We recommend that you Add to the Model Name to help make it easy for you to recognize which firearm is which. + +As shown in the Instructions above, I've added "Target" to the Walther P22 to help distinguish one from the other. + +**If you had to Copy Accessories from the original firearm to the new one, make sure you know which one you are copying to. One HINT that might help is that the Copy form for Accessories list the firearms in the order in which they where entered, so if I was going to copy an accessory from my first Glock to the new one, then I would have to select the last Glock in the list. EXAMPLE:** + +![](images/CopyFirearm_Duplicatename_warning_Copy_Ass.jpg) + + diff --git a/help/README.md b/help/README.md index b2fdbee..5206125 100644 --- a/help/README.md +++ b/help/README.md @@ -1,5 +1,5 @@ --- -sort: 1 +sort: 2 --- # My Gun Collection Help Home diff --git a/help/backup_database.md b/help/backup_database.md new file mode 100644 index 0000000..4576398 --- /dev/null +++ b/help/backup_database.md @@ -0,0 +1,21 @@ +# Backing up your Database + +Why would I need to Backup my Database (dB)? Well this is just a safety measure for your day to day business operations. If you had to restore your current PC, which involves wiping out everything and reinstalling it, or if you PC crashes, at least you will have your dB handy once you reinstall this program. + +To backup a database to a disk while in the program, click on picture of an open folder ( ![](images/Winxpicons_Disk_2_32x32.jpg) ) or you can hit you "F9" key. This will close out the "Apartment Manager" program and bring up the following window: + +![](images/backup_1.jpg) + +Why Did the "Apartment Manager" program close out? Well in order to free up the database(dB) that the program was using, we had to let the program go. From the "BurnSoft.Net DB Backup" program, select the drive that you wish to backup the database to. + +![](images/backup_2.jpg) + +After you select the drive that you wish to backup the dB to, click on the "Backup" button. + +![](images/backup_3.jpg) + +![](images/backup_4.jpg) + +If the program successfully backed up the dB, or if there was an error, a message box will come up and tell you. + +**We recommend that should be done at least once a month.** \ No newline at end of file