diff --git a/README.md b/README.md new file mode 100644 index 0000000..fce1857 --- /dev/null +++ b/README.md @@ -0,0 +1,98 @@ +
+ + AB Download Manager Logo + +
+

AB Download Manager

+

+ GitHub Release + AB Download Manager Website + Telegram Group + Telegram Channel +

+ +## Description + + +[AB Download Manager](https://abdownloadmanager.com) is a desktop app which let you manage and organize your download files better than before + + +## Features + +- ⚡️ Faster Download Speed +- ⏰ Queues and Schedulers +- 🌐 Browser Extensions +- 💻 Multiplatform (Windows / Linux for now) +- 🌙 Multiple Themes (Dark/Light) with modern UI +- ❤️ Free and Open Source + +Please visit [Project Website](https://abdownloadmanager.com) for more info + +## Installation + +in order to download and install the app + +- You can visit [Project Website](https://abdownloadmanager.com) for Download Instructions +- Or you can find download links for your OS from [GitHub Releases](https://github.com/amir1376/ab-download-manager/releases/latest) + +## Screenshots + +
+ + + + App Home Section + + + + + + App Download Section + +
+ +## Acknowledgements + +Please keep in mind that this project is in the beginning of its journey. +**lots of features** are on the way!. + +**But**, in the meantime you may face **Bugs or Problems**. so. +Please report them (by [Community chat](#community) or `GitHub Issues`) to me,And I'll do my best to fix them ASAP + +## Community + +You can join to our [Telegram Group](https://t.me/abdownloadmanager_discussion) to + +- Report problems +- Suggest features +- Get help about the app + +## Bug Report + +If you see bugs in the source code! please report them in the `GitHub Issues` section + +## Build From Source + +to compile and test desktop app on your local machine +fallow these steps. + +1. Clone the project +2. Install the [JBR](https://github.com/JetBrains/JetBrainsRuntime/releases) +3. cd into the project, open your terminal and execute the fallowing commands + +```bash +./gradlew + +./gradlew packageReleaseDistributionForCurrentOS +``` + +this will create a package for your **current OS**, so you can compile and install it on your own + +> **Note**. This project is compiled and published by GitHub actions [here](./.github/workflows/publish.yml), so if you +> faced any problem you can check that too + +## Contribution + +Contributions to this project are very welcome! + +Let's make a better Download Manager together ❤️ \ No newline at end of file diff --git a/assets/logo/app_logo_with_background.svg b/assets/logo/app_logo_with_background.svg new file mode 100644 index 0000000..348db5e --- /dev/null +++ b/assets/logo/app_logo_with_background.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/screenshots/app-download_dark.png b/assets/screenshots/app-download_dark.png new file mode 100644 index 0000000..6ee22d3 Binary files /dev/null and b/assets/screenshots/app-download_dark.png differ diff --git a/assets/screenshots/app-download_light.png b/assets/screenshots/app-download_light.png new file mode 100644 index 0000000..7e5160f Binary files /dev/null and b/assets/screenshots/app-download_light.png differ diff --git a/assets/screenshots/app-home_dark.png b/assets/screenshots/app-home_dark.png new file mode 100644 index 0000000..96ac260 Binary files /dev/null and b/assets/screenshots/app-home_dark.png differ diff --git a/assets/screenshots/app-home_light.png b/assets/screenshots/app-home_light.png new file mode 100644 index 0000000..62ec7e4 Binary files /dev/null and b/assets/screenshots/app-home_light.png differ