Skip to content

Commit 0bf0c44

Browse files
updating readme
1 parent 2f07abb commit 0bf0c44

1 file changed

Lines changed: 28 additions & 70 deletions

File tree

README.md

Lines changed: 28 additions & 70 deletions
Original file line numberDiff line numberDiff line change
@@ -1,100 +1,58 @@
1-
# FileMover
2-
3-
[![Python 3.7](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/downloads/release/python-360/) 
4-
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE.md) 
5-
![Update](https://img.shields.io/badge/update-monthly-green.svg) 
6-
7-
- [FileMover](#filemover)
8-
- [Introduction](#introduction)
9-
- [Python](#python)
10-
- [FileMover](#filemover-1)
11-
- [How To Run](#how-to-run)
12-
- [Installation](#installation)
13-
- [Usage](#usage)
14-
- [Support](#support)
15-
- [Roadmap](#roadmap)
16-
- [Contributing](#contributing)
17-
- [Authors and acknowledgment](#authors-and-acknowledgment)
18-
- [License](#license)
19-
- [Project status](#project-status)
20-
- [Author](#author)
1+
<h1 align="center">FileMover 📁</h1>
2+
<p align="center">Arrange your files smartly with filemover</p>
3+
4+
<p align="center">
5+
<img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License">
6+
<img src="https://img.shields.io/badge/update-monthly-green.svg" alt="update-montly">
7+
</p>
8+
9+
- [Introduction](#introduction)
10+
- [How To Run](#how-to-run)
11+
- [Documentation](#documentation)
12+
- [Changelog](#changelog)
13+
- [Usage](#usage)
14+
- [Contributors](#contributors)
15+
- [Contributing](#contributing)
16+
- [License](#license)
17+
- [Project status](#project-status)
2118

2219
## Introduction
2320

24-
### Python
25-
26-
Python is an interpreted, high-level, general-purpose programming language. Created by Guido van Rossum and first released in 1991, Python's design philosophy emphasizes code readability with its notable use of significant whitespace. Python Automation To Arrange Files In One Click with the help of Python 3.0+.
27-
28-
### FileMover
29-
3021
This tool allows automatic file moving, each file to the folder that corresponds to its extension (e.g. ".jpg" ==> "/Pictures", ".mp4" ==> "/Videos")
3122

3223
## How To Run
3324

34-
- Put in Download Folder Or Wherever You want to automatically move the file and Just run
35-
36-
For CLI
37-
3825
```bash
39-
python filemover.py
26+
pip install filemover
4027
```
4128

42-
For GUI
29+
## Documentation
4330

44-
```bash
45-
python filemovergui.py
46-
```
31+
Documentation is available at [filemover.readthedocs.io](https://filemover.readthedocs.io/en/latest/)
4732

48-
## Installation
33+
## Changelog
4934

50-
- This is A python 3 package.
51-
- Install Python 3.0+ or Anaconda 3.0+
35+
See [CHANGELOG.md](./CHANGELOG.md)
5236

5337
## Usage
5438

5539
FileMover Is a Python program to move files automatically with the help of Python. This will help you to manage your download folder for automatic cleanup.
5640

57-
## Support
58-
59-
Cotributors for the Project.
60-
61-
- [CodePerfectPLus](https://github.com/codePerfectPlus)
62-
- [AmiterCodes](https://github.com/AmiterCodes)
63-
- [Chems Eddine Senoussi](https://github.com/chemsedd)
41+
## Contributors
6442

65-
## Roadmap
43+
<a href="https://github.com/Py-Contributors/filemover/graphs/contributors">
44+
<img src="https://contrib.rocks/image?repo=Py-Contributors/filemover"/>
45+
</a>
6646

67-
what's new in a future update
68-
69-
- More File Extension will be added soon
70-
- Contributions are welcome
7147

7248
## Contributing
7349

74-
Before submitting a bug, please do the following:
75-
76-
Perform basic troubleshooting steps:
77-
78-
- ### Make sure you are on the latest version. If you are not on the most recent version, your problem may have been solved already! Upgrading is always the best first step
79-
80-
- ### Try older versions. If you are already on the latest release, try rolling back a few minor versions (e.g. if on 1.7, try 1.5 or 1.6) and see if the problem goes away. This will help the devs narrow down when the problem first arose in the commit log
81-
82-
- ### Try switching up dependency versions. If the software in question has dependencies (other libraries, etc) try upgrading/downgrading those as well
83-
84-
## Authors and acknowledgment
85-
86-
Show your appreciation to those who have contributed to the project.
50+
check [CONTRIBUTING.md](./CONTRIBUTING.md)
8751

8852
## License
8953

9054
For open-source projects, Under MIT License.
9155

9256
## Project status
9357

94-
## Author
95-
96-
- Module: FileMoverGUI
97-
- Author : Py-Contributors
98-
- Language: Python
99-
- Github: <https://github.com/codePerfectPlus>
100-
- Website: <http://codeperfectplus.herokuapp.com/>
58+
This project is developed and maintained by [Py-Contributors](https://github.com/Py-Contributors/FileMover).

0 commit comments

Comments
 (0)