toxblh/podcasts
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Added an overview to README.md .

Browse Source
This commit is contained in:
Jordan Petridis 2017-11-03 15:33:21 +02:00
parent 81af6765f1
commit 9787ce7979
No known key found for this signature in database
GPG Key ID: CEABAD9F5683B9A6
1 changed files with 26 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -2,15 +2,11 @@
## Multithreaded, safe, and reliable Gtk+ Podcast client.
This is a prototype of a podcast client written in Rust.
[![pipeline status](https://gitlab.gnome.org/alatiera/Hammond/badges/master/pipeline.svg)](https://gitlab.gnome.org/alatiera/Hammond/commits/master)
![podcasts_view](./assets/podcasts_view.png)
![podcast_widget](./assets/podcast_widget.png)
**A note about the project's name:**
The project was named after Allan Moore's character [Evey Hammond](https://en.wikipedia.org/wiki/Evey_Hammond) from the graphic novel V for Vendetta.
It has nothing to do with the horrible headlines on the news.
## Quick start
```sh
git clone https://gitlab.gnome.org/alatiera/hammond.git
@ -49,9 +45,31 @@ cargo build --all
## Overview:
To be added.
```sh
$ tree -d
├── assets # png's used in the README.md
├── hammond-data # Storate related stuff, Sqlite db, XDG setup.
│   ├── migrations # Diesel migrations.
│   │   └── ...
│   ├── src
│   └── tests
│   └── feeds # Raw RSS Feeds used for tests.
├── hammond-downloader # Really basic, Really crappy downloader.
│   └── src
├── hammond-gtk # The Gtk+ client.
│   ├── gtk # Contains the glade.ui files and.
│   └── src
│   ├── views # Currently only contains the Podcasts_view.
│   └── widgets # Contains custom widgets such as Podcast and Episode.
```
## Contributing:
There alot of thins to be done, take a look at TODO.md or grep for TODO: and FIXME:.
to be added: CONTRIBUTING.md
to be added: CONTRIBUTING.md
## A note about the project's name:
The project was named after Allan Moore's character [Evey Hammond](https://en.wikipedia.org/wiki/Evey_Hammond) from the graphic novel V for Vendetta.
It has nothing to do with the horrible headlines on the news.