You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 17, 2025. It is now read-only.
Copy file name to clipboardexpand all lines: README.md
+24-22
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@
9
9
10
10
## About Comet
11
11
12
-
**Comet** is a cross-platform video converter application designed to make video conversion as easy and accessible as possible. Leveraging the power of [FFmpeg](https://ffmpeg.org/), Comet allows users to convert video files into a variety of formats, all within a simple, intuitive interface.
12
+
**Comet** is a cross-platform video and audio converter application designed to make media conversion as easy and accessible as possible. Leveraging the power of [FFmpeg](https://ffmpeg.org/), Comet allows users to convert video and audio files into a variety of formats, all within a simple, intuitive interface.
13
13
14
14

15
15

@@ -18,47 +18,38 @@
18
18
19
19
## Project Overview
20
20
21
-
Comet's goal is to provide a free, user-friendly, and visually appealing application for converting video files. Whether you need to convert a single video or multiple files at once, Comet is here to help.
21
+
Comet's goal is to provide a free, user-friendly, and visually appealing application for converting video and audio files. Whether you need to convert a single file or multiple files at once, Comet is here to help.
22
22
23
23
### Key Features
24
24
25
25
-**Cross-Platform Compatibility:** Runs on macOS, Windows, and Linux.
26
-
-**Multiple Video Formats:** Supports conversion to a wide range of video formats including MP4, MKV, AVI, MOV, and more.
26
+
-**Video and Audio Conversion:** Supports conversion to a wide range of video formats (MP4, MKV, AVI, MOV, etc.) and audio formats (MP3, WAV, AAC, FLAC, etc.).
27
27
-**Bulk File Conversion:** Easily upload and convert multiple files in one go.
28
28
-**User-Friendly Interface:** A clean and intuitive UI that simplifies the conversion process.
29
29
-**Real-Time Conversion Feedback:** Conversion progress is tracked and displayed to the user, with real-time updates and error handling.
30
-
-**Fast Conversion:** Powered by FFmpeg, known for its speed and efficiency in video processing.
30
+
-**Fast Conversion:** Powered by FFmpeg, known for its speed and efficiency in media processing.
31
+
-**Dark Mode:** Provides a dark theme for users who prefer a more comfortable visual experience.
32
+
-**Multi-Language Support:** Available in multiple languages for a global audience.
31
33
32
34
### Current Status
33
35
34
36
The project has made significant progress:
35
37
36
38
-**Basic UI and Core Functionality:** The user interface is fully implemented, supporting bulk file uploads, conversion status tracking, and real-time feedback.
37
-
-**FFmpeg Integration:** The core video conversion functionality is complete, making the app fully functional.
39
+
-**FFmpeg Integration:** The core video and audio conversion functionality is complete, making the app fully functional.
38
40
-**Cross-Platform Distributables:** Distributables for macOS, Windows, and Linux have been successfully created. However, due to the high cost of an Apple Developer membership, the app is currently not code-signed or notarized for macOS, which may present challenges when running it on Mac devices.
39
41
40
42
## Technologies Used
41
43
42
44
-**Electron:** For building the cross-platform desktop application.
43
45
-**Vue.js (with Composition API and TypeScript):** For the frontend UI.
44
-
-**FFmpeg:** The core engine for video format conversion.
46
+
-**FFmpeg:** The core engine for video and audio format conversion.
45
47
-**Node.js:** Backend services and script automation.
46
48
-**Vite:** For fast and modern build tooling.
47
49
-**Tailwind CSS:** For styling and responsive design.
48
50
-**Jest:** For unit testing.
49
51
-**GitHub Actions:** For CI/CD and release automation.
50
52
51
-
## How to Contribute
52
-
53
-
We welcome contributions and collaboration! Whether you're a seasoned developer or just starting out, there's a place for you in our project. Here's how you can help:
54
-
55
-
1.**Fork the Repository:** Start by forking this repository to your GitHub account.
56
-
2.**Clone the Repo:** Clone the forked repo to your local machine using `git clone`.
57
-
3.**Set Up the Environment:** Follow the steps below to get the project running on your local machine.
58
-
4.**Create a Branch:** Create a new branch for the feature or fix you plan to work on.
59
-
5.**Submit a Pull Request:** Once your changes are ready, submit a pull request to the `main` branch of this repository.
60
-
6.**Star the Repository:** If you like this project, please give it a star on GitHub. It helps us gain visibility and grow our community!
61
-
62
53
### Getting Started
63
54
64
55
To get started with development:
@@ -113,11 +104,26 @@ To get started with development:
113
104
-**Overcome code signing challenges**, particularly on macOS due to the cost of an Apple Developer membership.
114
105
- Prepare for the first public release.
115
106
107
+
## Support
108
+
109
+
If you find this project helpful or interesting, please consider giving it a ⭐. Your support and feedback are greatly appreciated!
110
+
116
111
## Contributors
117
112
118
113
-**Jerome Thayananthajothy** - Project Lead & Developer
119
114
-[**Contributors List**](https://github.com/stellar-comet/comet/graphs/contributors) - A big thank you to all the amazing contributors!
120
115
116
+
## How to Contribute
117
+
118
+
We welcome contributions and collaboration! Whether you're a seasoned developer or just starting out, there's a place for you in our project. Here's how you can help:
119
+
120
+
1.**Fork the Repository:** Start by forking this repository to your GitHub account.
121
+
2.**Clone the Repo:** Clone the forked repo to your local machine using `git clone`.
122
+
3.**Set Up the Environment:** Follow the steps below to get the project running on your local machine.
123
+
4.**Create a Branch:** Create a new branch for the feature or fix you plan to work on.
124
+
5.**Submit a Pull Request:** Once your changes are ready, submit a pull request to the `main` branch of this repository.
125
+
6.**Star the Repository:** If you like this project, please give it a star on GitHub. It helps us gain visibility and grow our community!
126
+
121
127
## License
122
128
123
129
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
@@ -127,10 +133,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
127
133
-[FFmpeg](https://ffmpeg.org/) - The powerful multimedia framework that makes this project possible.
128
134
- The Electron and Vue.js communities for their fantastic tools and support.
129
135
130
-
## Support
131
-
132
-
If you find this project helpful or interesting, please consider giving it a ⭐. Your support and feedback are greatly appreciated!
133
-
134
136
---
135
137
136
-
Thank you for visiting our project! We’re excited to bring this tool to life and make video conversion easy and accessible for everyone. Any help, be it in coding, testing, or simply providing feedback, is invaluable. Let's create something great together!
138
+
Thank you for visiting our project! We’re excited to bring this tool to life and make media conversion easy and accessible for everyone. Any help, be it in coding, testing, or simply providing feedback, is invaluable. Let's create something great together!
0 commit comments