diff --git a/README.md b/README.md index 2b399a8..21f6384 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,285 @@ -# Media Sorter + + +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![MIT License][license-shield]][license-url] +[![LinkedIn][linkedin-shield]][linkedin-url] -A python app to sort and manage media by date, camera type, etc ... using metadata. -[//]: # (Todo: Create the Readme) \ No newline at end of file + + +
+
+ + Logo + + +

Media Sorter

+ +

+ A simple script to sort your media! +
+ Explore the docs » +
+
+ View Demo + +[//]: # ( ·) + +[//]: # ( Report Bug) + +[//]: # ( ·) + +[//]: # ( Request Feature) +

+
+ + + + +
+ Table of Contents +
    +
  1. + About The Project + +
    2. +
  2. + Getting Started + +
    3. +
  3. Usage
    4. +
  4. Roadmap
    5. +
  5. Contributing
    6. +
  6. License
    7. +
  7. Contact
    8. +
  8. Acknowledgments
    9. +
+
+ + + + +## About The Project + +There are many great media sorters out there, but none really suited me. So I created my own. The main idea here is simplicity, and the ability to sort even media who has missing or unusual tags. +This app is built with [![Python][Python]][Python] and leverages [![ExifTool][ExifTool]][ExifTool-url] + +

(back to top)

+ + + +[//]: # () + +[//]: # (## Getting Started) + +[//]: # () +[//]: # (This is an example of how you may give instructions on setting up your project locally.) + +[//]: # (To get a local copy up and running follow these simple example steps.) + +[//]: # () +[//]: # (### Prerequisites) + +[//]: # () +[//]: # (This is an example of how to list things you need to use the software and how to install them.) + +[//]: # (* npm) + +[//]: # ( ```sh) + +[//]: # ( npm install npm@latest -g) + +[//]: # ( ```) + +[//]: # () +[//]: # (### Installation) + +[//]: # () +[//]: # (_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._) + +[//]: # () +[//]: # (1. Get a free API Key at [https://example.com](https://example.com)) + +[//]: # (2. Clone the repo) + +[//]: # ( ```sh) + +[//]: # ( git clone https://github.com/your_username_/Project-Name.git) + +[//]: # ( ```) + +[//]: # (3. Install NPM packages) + +[//]: # ( ```sh) + +[//]: # ( npm install) + +[//]: # ( ```) + +[//]: # (4. Enter your API in `config.js`) + +[//]: # ( ```js) + +[//]: # ( const API_KEY = 'ENTER YOUR API';) + +[//]: # ( ```) + +[//]: # () +[//]: # (

(back to top)

) + +[//]: # () +[//]: # () +[//]: # () +[//]: # () + +[//]: # (## Usage) + +[//]: # () +[//]: # (Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.) + +[//]: # () +[//]: # (_For more examples, please refer to the [Documentation](https://example.com)_) + +[//]: # () +[//]: # (

(back to top)

) + +[//]: # () +[//]: # () +[//]: # () +[//]: # () + +[//]: # (## Roadmap) + +[//]: # () +[//]: # (- [x] Add Changelog) + +[//]: # (- [x] Add back to top links) + +[//]: # (- [ ] Add Additional Templates w/ Examples) + +[//]: # (- [ ] Add "components" document to easily copy & paste sections of the readme) + +[//]: # (- [ ] Multi-language Support) + +[//]: # ( - [ ] Chinese) + +[//]: # ( - [ ] Spanish) + +[//]: # () +[//]: # (See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).) + +[//]: # () +[//]: # (

(back to top)

) + +[//]: # () +[//]: # () +[//]: # () +[//]: # () + +[//]: # (## Contributing) + +[//]: # () +[//]: # (Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.) + +[//]: # () +[//]: # (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".) + +[//]: # (Don't forget to give the project a star! Thanks again!) + +[//]: # () +[//]: # (1. Fork the Project) + +[//]: # (2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)) + +[//]: # (3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)) + +[//]: # (4. Push to the Branch (`git push origin feature/AmazingFeature`)) + +[//]: # (5. Open a Pull Request) + +[//]: # () +[//]: # (

(back to top)

) + + + + +## License + +Distributed under the Apache-2.0 License. See `LICENSE.txt` for more information. + +

(back to top)

+ + + + +## Contact + +Ahmad Obeid - obeid.ahmad2001@outlook.com + +Project Link: [https://github.com/obeidahmad/family-media-sorter](https://github.com/obeidahmad/family-media-sorter) + +

(back to top)

+ + + +[//]: # () + +[//]: # (## Acknowledgments) + +[//]: # () +[//]: # (Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!) + +[//]: # () +[//]: # (* [Choose an Open Source License](https://choosealicense.com)) + +[//]: # (* [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)) + +[//]: # (* [Malven's Flexbox Cheatsheet](https://flexbox.malven.co/)) + +[//]: # (* [Malven's Grid Cheatsheet](https://grid.malven.co/)) + +[//]: # (* [Img Shields](https://shields.io)) + +[//]: # (* [GitHub Pages](https://pages.github.com)) + +[//]: # (* [Font Awesome](https://fontawesome.com)) + +[//]: # (* [React Icons](https://react-icons.github.io/react-icons/search)) + +[//]: # () +[//]: # (

(back to top)

) + + + + + +[contributors-shield]: https://img.shields.io/github/contributors/obeidahmad/family-media-sorter.svg?style=for-the-badge +[contributors-url]: https://github.com/obeidahmad/family-media-sorter/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/obeidahmad/family-media-sorter.svg?style=for-the-badge +[forks-url]: https://github.com/obeidahmad/family-media-sorter/network/members +[stars-shield]: https://img.shields.io/github/stars/obeidahmad/family-media-sorter.svg?style=for-the-badge +[stars-url]: https://github.com/obeidahmad/family-media-sorter/stargazers +[issues-shield]: https://img.shields.io/github/issues/obeidahmad/family-media-sorter.svg?style=for-the-badge +[issues-url]: https://github.com/obeidahmad/family-media-sorter/issues +[license-shield]: https://img.shields.io/github/license/obeidahmad/family-media-sorter.svg?style=for-the-badge +[license-url]: https://github.com/obeidahmad/family-media-sorter/blob/master/LICENSE.txt +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/ahmad-obeid-487a8a204/ +[Python]: https://img.shields.io/badge/python-3776AB?style=for-the-badge&logo=python&logoColor=white +[Python-url]: https://www.python.org/ +[ExifTool]: https://img.shields.io/badge/exiftool-red.svg?style=for-the-badge&logo=data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8c3ZnIHByZXNlcnZlQXNwZWN0UmF0aW89InhNaWRZTWlkIG1lZXQiIHZpZXdCb3g9IjM1LjE5OTk5OTk5OTk5OTk5NiAzMCAxMzUuMjAwMDAwMDAwMDAwMDIgMTQwLjc5OTk5OTk5OTk5OTk4IiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZlcnNpb249IjEuMCIgc3R5bGU9Im1heC1oZWlnaHQ6IDUwMHB4IiB3aWR0aD0iMTM1LjIwMDAwMDAwMDAwMDAyIiBoZWlnaHQ9IjE0MC43OTk5OTk5OTk5OTk5OCI+Cgo8ZyBzdHJva2U9Im5vbmUiIGZpbGw9IiMwMDAwMDAiIHRyYW5zZm9ybT0idHJhbnNsYXRlKDAuMDAwMDAwLDIwMC4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiPgo8cGF0aCBkPSJNMzcwIDExMDUgbDAgLTU2NSAzMzAgMCAzMzAgMCAwIDcwIDAgNzAgLTI1NSAwIC0yNTUgMCAwIDE5MCAwIDE5MCYjMTA7MjU1IDAgMjU1IDAgMCA2NSAwIDY1IC0yNTUgMCAtMjU1IDAgMCAxNzUgMCAxNzUgMjU1IDAgMjU1IDAgMCA2NSAwIDY1IC0zMzAmIzEwOzAgLTMzMCAwIDAgLTU2NXoiLz4KPHBhdGggZD0iTTc2MCAxMzcwIGwwIC03MCAxOTAgMCAxOTAgMCAwIC00OTUgMCAtNDk1IDgwIDAgODAgMCAwIDQ5NSAwIDQ5NSYjMTA7MTkwIDAgMTkwIDAgMCA3MCAwIDcwIC00NjAgMCAtNDYwIDAgMCAtNzB6Ii8+CjwvZz4KPC9zdmc+Cg== +[ExifTool-url]: https://www.exiftool.org/ \ No newline at end of file diff --git a/images/logo.svg b/images/logo.svg new file mode 100644 index 0000000..1aa0f39 --- /dev/null +++ b/images/logo.svg @@ -0,0 +1,3 @@ + + + \ No newline at end of file diff --git a/src/main.py b/src/main.py index 6eb4f05..5040b64 100644 --- a/src/main.py +++ b/src/main.py @@ -50,4 +50,4 @@ def main(): if __name__ == "__main__": - main() \ No newline at end of file + main()