Skip to content

Commit

Permalink
Writing the README
Browse files Browse the repository at this point in the history
  • Loading branch information
giantpinkrobots authored Nov 28, 2023
1 parent 1af2c5e commit 5e4edc3
Showing 1 changed file with 35 additions and 4 deletions.
39 changes: 35 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,41 @@
# varia
Download manager based on aria2
<p align="center"><img src="https://raw.githubusercontent.com/giantpinkrobots/varia/main/data/icons/hicolor/scalable/apps/io.github.giantpinkrobots.varia.svg" width=200 /></p>
<h1 align="center">Varia</h1>
<h3 align="center">Download manager based on aria2</h3>
<br>

I will write this once this app is released on Flathub.
<p align="center">

![](https://img.shields.io/github/commits-since/giantpinkrobots/varia/latest/main?label=commits%20since%20latest%20release) ![](https://img.shields.io/github/forks/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/stars/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/watchers/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/issues/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/issues-closed/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/issues-pr/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/issues-pr-closed/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/license/giantpinkrobots/varia.svg) ![](https://img.shields.io/github/followers/giantpinkrobots.svg?style=social&label=Follow&maxAge=2592000)

This application relies on the following pieces of software:
</p>

<p align="center"><a href="https://flathub.org/apps/io.github.giantpinkrobots.varia"><img src="https://dl.flathub.org/assets/badges/flathub-badge-i-en.svg" width=300 /></a></p>

Varia is a simple download manager that conforms to the latest Libadwaita design guidelines, integrating nicely with GNOME. It uses the amazing aria2 to handle the downloads.

<p float="left" align="middle">
<img src="https://raw.githubusercontent.com/giantpinkrobots/varia/main/screenshots/Screenshot-Varia-1.png" width=500 />
<img src="https://raw.githubusercontent.com/giantpinkrobots/varia/main/screenshots/Screenshot-Varia-2.png" width=500 />
</p>

Varia supports some basic functionality you'd expect from a download manager such as resuming incomplete downloads upon relaunch, but (right now) doesn't support saving files outside of your default download directory. I want to change this in the future while still having a minimal set of permissions with Flatpak.

## License

<a href=https://github.com/giantpinkrobots/varia/blob/main/LICENSE>Varia is licensed under the Mozilla Public License 2.0.</a>

But, it also application relies on the following pieces of software:
- aria2: GPL v2 License (aria2 itself relies on OpenSSL: OpenSSL License)
- aria2p: ISC License

The licenses of all of these pieces of software can be found in the dependencies_information directory in this application's app directory.

## Contributing

Contributions are always welcome, of course! I have not set up translations yet, and this time I want to utilize the .po files to do it. I will update this section once that is in.

Also, I really want to change the logo as it's something I hastly hacked together in Krita. If you can make a logo that conforms to the GNOME logo design guidelines, that would be amazing!

## The name

The name "Varia" comes from the aria2 software it is based on, and I added a "V" to make it "Varia". In the Metroid series of games, there is a special suit you eventually get named a "<a href=https://metroid.fandom.com/wiki/Varia_Suit>Varia Suit</a>" with its main feature being allowing Samus to withstand extreme temperatures. I spent some time thinking about how to connect the Varia Suit to my app, but couldn't, soooo... I think it just sounds cool.

0 comments on commit 5e4edc3

Please sign in to comment.