Merge pull request #47 from REALSDEALS/REALSDEALS

Update: Documentation

Documentation/changelog.md

@@ -1,5 +1,13 @@
 # Changelog.md - pcHealth
 
+## 08-12-2021
+
+Updated the README.md
+Updated releases.md
+Updated this Changelog.md
+
+New release has been pushed on GitHub.
+
 ## 07-12-2021
 
 Added code to make the program aware if it is being run in Admin mode.

Documentation/releases.md

@@ -5,10 +5,11 @@ For now only the version names will be displayed, in the future there might be e
 
 ## Latest Version
 
-Alpha Release - v.0.1.3-alpha
+Alpha Release - v.0.1.4-alpha
 
 ### Older Releases
 
+- Alpha Release - v.0.1.3-alpha
 - Alpha Release - v.0.1.2-alpha
 - Alpha Release - v.0.1.1-alpha
 - Alpha Release - v.0.1.0-alpha

README.md

@@ -1,12 +1,12 @@
 # pcHealth
 
-Check the health of your Windows installation!
+Check the health of your Windows installation and much more!
 
-![GitHub Repo Size](https://img.shields.io/github/repo-size/REALSDEALS/pcHealth?label=Repo%20Size) ![GitHub Top Language](https://img.shields.io/github/languages/top/REALSDEALS/pcHealth?color=green&label=Batchfile) ![Github](https://img.shields.io/github/license/REALSDEALS/pcHealth)
+![GitHub Repo Size](https://img.shields.io/github/repo-size/REALSDEALS/pcHealth?label=Repo%20Size) ![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/REALSDEALS/pcHealth?include_prereleases&label=Latest%20Release) ![GitHub Top Language](https://img.shields.io/github/languages/top/REALSDEALS/pcHealth?color=green&label=Batchfile) ![Github](https://img.shields.io/github/license/REALSDEALS/pcHealth)
 
 ## What is the main purpose?
 
-pcHealth is an executable .bat file, which gives you the possibility to check your Windows installation. It can scan, log any problems, check your battery and can try to repair your 'corrupted' Windows installation.
+pcHealth is an ececutable .bat file, which gives you the possibility to check not only your Windows installation on corrupt files, but it can also check your battery level. This is handy if your laptop can't hold its battery power properly. Besides that you can also get your Ninite from the script! It is also possible to open and re-open the created logs.
 
 ## How to use?
 
@@ -15,15 +15,59 @@ It's quite a handy tool for any IT'er or other computer related problem solving/
 
 ### Now more information on how to use it;
 
-- Right-click and run the .bat file in Administrator mode.
-- Read the lines carefully.
-- Enter in a number to run the desired command - (Number + ENTER)
-- Patiently wait for the script to finish, it will have a positive or a negative outcome.
-- If it's negative try and run it again, or start with the DISM command, in case you started with '1'.
-- If it worked and repaired the system, reboot your system and try to run the first command again.
-- Now it should say that there are no files found that needed any repairing.
+- Download the .bat file.
+- Extract it to the desktop to be sure that it will run with the full permissions.
+- Once openend, read the rules carefully.
+- Enter in the number of the desired command that you want to run. (Number + ENTER)
+- Patiently wait for the script to finish.
+- You can chose, depending on the command, what you want to do next. (Open logs ect.)
 
-- When running a battery report, it should save the file/log in your main :C disk.
+### SFC - Number 1
+
+When running SFC the command will start an system scan, to check the integrity of the Windows files.
+When it comes back positive you don't have to do anything else, your system doesn't have any corrupt files, Windows related.
+
+When it comes back negative, you have the option to check the logs (be sure to check the bottem of the log) to see what is in need of a repair. After that you have the option to start the DISM command to try and repair the corrupt files. If this works you may want to restart your pc and run the SFC command again.
+
+### DISM - Number 2
+
+The DISM command is a command to run an image scan/check and/or repair of your Windows image (iso.)
+
+If the commands fail, you get the option to repair the image.
+This may not work, if it doesn't and errors keep appearing, then it might be smart to re-install the pc with a clean version of Windows.
+
+### SFC & DISM - Number 3
+
+This entry runs the SFC and the DISM command after each other.
+After the SFC you get the option to return to the menu when no corrupt files are found.
+
+### Battery report - Number 4
+
+When you enter this number the script will generate a battery report.
+In this battery report you can read up on your battery status from your laptop.
+
+### Re-open the Battery Report - Number 5
+
+This entry will re-open the generated battery report file.
+
+### Re-open the DISM Log - Number 6
+
+With this entry you can re-open the DISM/CBS.log.
+
+### Get your Ninite - Number 7
+
+When entered number 7 a download will start, this download will install:
+
+- Edge
+- Chrome
+- VLC
+- 7ZIP
+
+Edge will be installed so you have the latest version of it, after a clean install this is recommanded.
+
+### Close the Script
+
+With number 8 you can close the script.
 
 ## Questions