Skip to content

Commit ca4f29a

Browse files
vigneshs-devvigneshs-dev
committed
Update README.md file
1 parent 31ece66 commit ca4f29a

File tree

2 files changed

+149
-27
lines changed

2 files changed

+149
-27
lines changed

‎README.md

Lines changed: 149 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,165 @@
1-
# Desktop Cleaner
1+
<!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 -->
2+
<a name="readme-top"></a>
23

34

5+
<!-- PROJECT SHIELDS ferosh -->
6+
<!--
7+
*** I'm using markdown "reference style" links for readability.
8+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
9+
*** See the bottom of this document for the declaration of the reference variables
10+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
11+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
12+
-->
413

5-
Desktop Cleaner is used to clean and organise your files in separate folders based on the created/downloaded dates.
614

15+
<!-- PROJECT LOGO -->
16+
<br />
17+
<div align="center">
18+
<a href="https://github.com/github_username/repo_name">
19+
<img src="images/logo.png" alt="Logo" width="100" height="80">
20+
</a>
721

8-
## Prerequisits
22+
<h3 align="center">Desktop Cleaner</h3>
923

10-
Before cloning/forking this project, make sure you have the following tools installed:
24+
<p align="center">
25+
Desktop Cleaner is used to clean and organise your files in separate folders based on the created/downloaded dates.
26+
<!-- <br />
27+
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
28+
<br />
29+
<br />
30+
<a href="https://github.com/github_username/repo_name">View Demo</a>
31+
·
32+
<a href="https://github.com/github_username/repo_name/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
33+
·
34+
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a> -->
35+
</p>
36+
</div>
1137

12-
- [Git](https://git-scm.com/downloads)
13-
- [Python](https://www.python.org/downloads/)
1438

15-
## Installation
1639

17-
1. Fork the project
40+
<!-- TABLE OF CONTENTS -->
41+
<details>
42+
<summary>Table of Contents</summary>
43+
<ol>
44+
<li>
45+
<a href="#about-the-project">About The Project</a>
46+
<ul>
47+
<li><a href="#built-with">Built With</a></li>
48+
</ul>
49+
</li>
50+
<li>
51+
<a href="#getting-started">Getting Started</a>
52+
<ul>
53+
<li><a href="#prerequisites">Prerequisites</a></li>
54+
<li><a href="#installation">Installation</a></li>
55+
</ul>
56+
</li>
57+
<li><a href="#contributing">Contributing</a></li>
58+
<li><a href="#license">License</a></li>
59+
</ol>
60+
</details>
1861

19-
2. Clone the project
20-
```bash
21-
git clone https://github.com/VigneshVicky97/Desktop_Cleaner.git
22-
```
23-
4. Navigate to the project directory
24-
```bash
25-
cd Desktop_Cleaner
26-
```
27-
5. Install the dependencies
28-
```bash
29-
pip install -r requirements.txt
30-
```
31-
6. Run the project
32-
```bash
33-
python cleandesk.py
34-
```
3562

63+
64+
<!-- ABOUT THE PROJECT -->
65+
## About The Project
66+
67+
<!-- <p align="center">
68+
<a href="https://example.com">
69+
<img src="images/screenshot.png" alt="Product Name Screen Shot">
70+
</a>
71+
</p> -->
72+
73+
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
74+
75+
This app is used to clean your desktop by categorising the files in your system into respective folders. This can be made to run everyday at a particular time by automating the process.
76+
77+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
78+
79+
80+
81+
### Built With
82+
83+
![Python](https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffdd54)
84+
85+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
86+
87+
88+
<!-- GETTING STARTED -->
89+
## Getting Started
90+
91+
To get a local copy up and running follow these simple example steps.
92+
93+
### Prerequisites
94+
95+
96+
* Python 3.12.0
97+
98+
99+
### Installation
100+
101+
1. Clone the repo
102+
```sh
103+
git clone https://github.com/VigneshVicky97/Desktop_Cleaner.git
104+
```
105+
2. Navigate to the project directory
106+
```sh
107+
cd Desktop_Cleaner
108+
```
109+
3. Install the dependencies
110+
```sh
111+
pip install -r requirements.txt
112+
```
113+
4. Run the project
114+
```sh
115+
python cleandesk.py
116+
```
117+
118+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
119+
120+
121+
122+
<!-- CONTRIBUTING -->
36123
## Contributing
37124

38-
Pull requests are welcome. For major changes, please open an issue first
39-
to discuss what you would like to change.
125+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
126+
127+
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
128+
Don't forget to give the project a star! Thanks again!
129+
130+
1. Fork the Project
131+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
132+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
133+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
134+
5. Open a Pull Request
135+
136+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
137+
40138

139+
140+
<!-- LICENSE -->
41141
## License
42142

43-
[MIT](https://github.com/VigneshVicky97/Desktop_Cleaner?tab=MIT-1-ov-file)
143+
Distributed under the MIT License. See `LICENSE.txt` for more information.
144+
145+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
146+
147+
148+
<!-- MARKDOWN LINKS & IMAGES -->
149+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
150+
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
151+
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
152+
[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
153+
[forks-url]: https://github.com/github_username/repo_name/network/members
154+
[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
155+
[stars-url]: https://github.com/github_username/repo_name/stargazers
156+
[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
157+
[issues-url]: https://github.com/github_username/repo_name/issues
158+
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
159+
[license-url]: https://github.com/VigneshVicky97/Desktop_Cleaner?tab=MIT-1-ov-file
160+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
161+
[linkedin-url]: https://linkedin.com/in/linkedin_username
162+
163+
164+
165+

‎images/logo.png

397 KB
Loading

0 commit comments

Comments
 (0)