Updated Readme and TODO.
This commit is contained in:
Jordan Petridis
parent
cfb876e006
commit
e2403255cf
32
README.md
32
README.md
@ -63,12 +63,34 @@ dnf install -y gtk3-devel glib2-devel openssl-devel sqlite-devel meson
|
||||
```
|
||||
|
||||
If you happen to build it on other distributions please let me know the names of the corresponding libraries. Feel free to open a PR or an Issue to note it.
|
||||
|
||||
```sh
|
||||
git clone https://gitlab.gnome.org/alatiera/Hammond.git
|
||||
cd Hammond/
|
||||
cargo build --all
|
||||
```
|
||||
|
||||
## Call for designers
|
||||
|
||||
Currently there no design plans or mockups. They are highly needed in order to advance the Gtk Client.
|
||||
|
||||
There is the will for a complete client re-write if a someone contributes the mockups.
|
||||
|
||||
If you happen to be a designer and want to contribute please hope on [#hammond](https://docs.python.org/3/library/exceptions.html) and get in touch with us.
|
||||
|
||||
## Contributing
|
||||
|
||||
There alot of thins yet to be done.
|
||||
|
||||
If you want to contribute, please check the [Contributions Guidelines][contribution-guidelines].
|
||||
|
||||
You can find start by taking a look at [Issues](https://gitlab.gnome.org/alatiera/Hammond/issues) or Opening a [New one](https://gitlab.gnome.org/alatiera/Hammond/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=).
|
||||
|
||||
There are also some minor tasks tagged with `TODO:` and `FIXME:` in the source code.
|
||||
|
||||
[contribution-guidelines]: https://gitlab.gnome.org/alatiera/Hammond/blob/master/CONTRIBUTING.md
|
||||
|
||||
|
||||
## Overview
|
||||
|
||||
```sh
|
||||
@ -90,16 +112,6 @@ $ tree -d
|
||||
│ └── widgets # Contains custom widgets such as Podcast and Episode.
|
||||
```
|
||||
|
||||
## Contributing
|
||||
There alot of thins yet to be done.
|
||||
|
||||
You can find start by taking a look at [Issues](https://gitlab.gnome.org/alatiera/Hammond/issues) or Opening a [New one](https://gitlab.gnome.org/alatiera/Hammond/issues/new?issue%5Bassignee_id%5D=&issue%5Bmilestone_id%5D=).
|
||||
|
||||
You may also want to take a look at [TODO.md](https://gitlab.gnome.org/alatiera/Hammond/blob/master/TODO.md) or grep the source code for `TODO:` and `FIXME:` tags.
|
||||
|
||||
If you want to contribute, please check the [Contributions Guidelines][contribution-guidelines].
|
||||
[contribution-guidelines]: https://gitlab.gnome.org/alatiera/Hammond/blob/master/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.
|
||||
|
||||
70
TODO.md
70
TODO.md
@ -2,61 +2,31 @@
|
||||
|
||||
**General:**
|
||||
|
||||
- [x] Add CONTRIBUTING.md
|
||||
- [x] Add Issues and Pull Request templates
|
||||
- [ ] Write docs
|
||||
|
||||
## Planned Features
|
||||
|
||||
## Priorities:
|
||||
|
||||
**Would be nice:**
|
||||
|
||||
- [x] Use GResource for assets like the banner.png etc, instead of hardcoded paths.
|
||||
- [x] Possibly Convert description labels to textview.
|
||||
- [ ] Make Podcast cover fetchng and loading not block the execution of the program at startup.
|
||||
- [ ] Re-design EpisodeWidget.
|
||||
- [ ] Lazy evaluate episode loading based on the podcast_widget's view scrolling.
|
||||
- [ ] Headerbar back button and stack switching
|
||||
- [x] New episode notifier on podcast_flowbox_child, like the one vocal has
|
||||
- [ ] Polish the flowbox_child banner.
|
||||
- [x] Update on startup
|
||||
|
||||
|
||||
**Unhack stuff:**
|
||||
|
||||
- [ ] Url sanitization
|
||||
- [x] Fix downloader .ext parsing
|
||||
|
||||
|
||||
**FIXME:**
|
||||
|
||||
- [x] Fix Flowbox child activation. [#1](https://gitlab.gnome.org/alatiera/Hammond/issues/1)
|
||||
- [ ] Fix Etag/Last-modified implementation. [#2](https://gitlab.gnome.org/alatiera/Hammond/issues/2)
|
||||
|
||||
|
||||
**DB changes:**
|
||||
|
||||
- [x] episodes: add watched field
|
||||
- [x] Podcast deletion
|
||||
- [x] Download cleaner
|
||||
|
||||
|
||||
## Secondary:
|
||||
|
||||
- [ ] Discuss and decide when to schedule the download cleaner. [#3](https://gitlab.gnome.org/alatiera/Hammond/issues/3)
|
||||
- [ ] Unplayed Only and Downloaded only view.
|
||||
- [ ] Auto-updater
|
||||
- [ ] Make use of file metadas, [This](https://github.com/GuillaumeGomez/audio-video-metadata) might be helpfull.
|
||||
- [ ] OPML import/export // Probably need to create a crate.
|
||||
|
||||
**Proper Desing Mockups for the Gtk Client:**
|
||||
|
||||
- [ ] Re-design EpisodeWidget.
|
||||
- [ ] Re-design PodcastWidget.
|
||||
- [ ] Polish the flowbox_child banner.
|
||||
|
||||
**DB changes:**
|
||||
|
||||
- [ ] Mark episodes/podcast for archival
|
||||
- [ ] Mark stuff as Favorite. Maybe auto-archive favorites?
|
||||
|
||||
## Second:
|
||||
|
||||
## Third:
|
||||
|
||||
- [ ] Make use of file metadas, [This](https://github.com/GuillaumeGomez/audio-video-metadata) might be helpfull.
|
||||
- [ ] Notifications
|
||||
- [ ] Episode queue
|
||||
- [ ] Embedded player
|
||||
@ -64,8 +34,28 @@
|
||||
- [ ] Search Implementation
|
||||
|
||||
|
||||
## Fourth:
|
||||
## Third:
|
||||
|
||||
- [ ] Download Queue
|
||||
- [ ] Ability to Stream content on demand
|
||||
- [ ] soundcloud and itunes feeds // [This](http://getrssfeed.com) seems intresting.
|
||||
- [ ] Integrate with Itunes API for various crap
|
||||
- [ ] YoutubeFeeds
|
||||
|
||||
## Rest Tasks
|
||||
|
||||
**Would be nice:**
|
||||
|
||||
- [ ] Make Podcast cover fetchng and loading not block the execution of the program at startup.
|
||||
- [ ] Lazy evaluate episode loading based on the podcast_widget's view scrolling.
|
||||
- [ ] Headerbar back button and stack switching
|
||||
|
||||
|
||||
**Unhack stuff:**
|
||||
|
||||
- [ ] Url sanitization
|
||||
|
||||
|
||||
**FIXME:**
|
||||
|
||||
- [ ] Fix Etag/Last-modified implementation. [#2](https://gitlab.gnome.org/alatiera/Hammond/issues/2)
|
||||
|
||||
Loading…
Reference in New Issue
Block a user