Skip to content

Commit e4d1a5a

Browse files
committed
win-script: README.md: update documentation
Signed-off-by: KARTHIK LAL <[email protected]>
1 parent 510a3e8 commit e4d1a5a

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,15 @@
33
* This is a simple windows clean-up project. It is intended to be used as a tool to clean up your windows environment.
44
* It is not intended to be a replacement for a full-functional tool.
55

6-
## <b> HOW TO USE THIS PROJECT </b>
6+
## <b> HOW TO USE THIS SCRIPT/SOFTWARE </b>
7+
8+
### <b> METHOD 1 (Recommended) </b>
9+
10+
* ` Download the latest release of this project from [GitHub](https://github.com/karthik558/clean-windows/releases) `
11+
* ` Extract the zip file `
12+
* ` Run the `clean-windows.exe` file as adminisrator privileges `
13+
14+
### <b> METHOD 2 </b>
715

816
* ` git clone https://github.com/karthik558/clean-windows.git `
917
* ` cd clean-windows `
@@ -13,13 +21,13 @@
1321

1422
* This script is just a simple wrapper around the `clean-win.bat` script.
1523
* Every commands on this script can be executed by just typing the command name. (i made it easily that's it.)
16-
* TOOLS ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND AND THE AUTHOR IS NOT RESPONSIBLE FOR ANY DAMAGE CAUSED BY THE USE OF THESE TOOLS
17-
* USE AT YOUR OWN RISK
24+
* TOOLS ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND AND THE AUTHOR IS NOT RESPONSIBLE FOR ANY DAMAGE CAUSED BY THE USE OF THESE TOOLS.
25+
* USE AT YOUR OWN RISK.
1826

1927
## <b> CONTRIBUTION AND LISCENCE </b>
2028

21-
* If you want to contribute to this project, then follow github-basic-contribution rules. (inlude signoff and commit message) (https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/writing-a-pull-request)
22-
* LICESNSE: GNU GENERAL PUBLIC LICENSE V3.0
23-
* OPENSOURCE SOFTWARE LICENSE AGREEMENT FOR WINDOWS DISTRIBUTION SYSTEM (https://www.gnu.org/licenses/gpl-3.0.en.html)
29+
* If you want to contribute to this project, then follow github-basic-contribution rules. (inlude signoff and commit message) (https://help.github.com/en/github collaborating-with-issues-and-pull-requests/writing-a-pull-request).
30+
* LICESNSE: GNU GENERAL PUBLIC LICENSE V3.0.
31+
* OPENSOURCE SOFTWARE LICENSE AGREEMENT FOR WINDOWS DISTRIBUTION SYSTEM (https://www.gnu.org/licenses/gpl-3.0.en.html).
2432
* Copying and distribution of this file, with or without modification, are permitted in any medium without royalty provided the copyright notice and this notice are preserved.
2533
* Copyright (c) 2022, KARTHIK LAL. All rights reserved.

0 commit comments

Comments
 (0)