From d46c3716b42c3abfa709ccf3686f533ab1aa4d4a Mon Sep 17 00:00:00 2001 From: Jordan Petridis Date: Fri, 10 Nov 2017 12:54:09 +0200 Subject: [PATCH] Close #11, Added notes for manual installation. --- README.md | 20 +++++++++++++++++++- TODO.md | 12 ++++++------ 2 files changed, 25 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5c87ccf..441b03a 100644 --- a/README.md +++ b/README.md @@ -7,12 +7,30 @@ This is a prototype of a podcast client written in Rust. ![podcasts_view](./assets/podcasts_view.png) ![podcast_widget](./assets/podcast_widget.png) -## Quick start +The following steps assume you have a working installation of rustc and cargo. +If you dont take a look at [rustup.rs](rustup.rs) + +## Quick start: ```sh git clone https://gitlab.gnome.org/alatiera/hammond.git cd Hammond/ cargo run -p hammond-gtk --release ``` + +## Install from soure: +```sh +git clone https://gitlab.gnome.org/alatiera/hammond.git +cd Hammond/ +make +sudo make install +``` + +**Additionall:** + +You can run `sudo make uninstall` for removal + +And `make clean` to clean up the enviroment after instalation. + ### Flatpak: Flatpak instructions... Soon™. diff --git a/TODO.md b/TODO.md index ef03332..307c821 100644 --- a/TODO.md +++ b/TODO.md @@ -24,7 +24,7 @@ **Unhack stuff:** - [ ] Url sanitization -- [ ] Fix downloader .ext parsing +- [x] Fix downloader .ext parsing **FIXME:** @@ -35,7 +35,7 @@ **Look into:** -- [ ] Icons && install stuff && flatpak +- [x] Icons && install stuff && flatpak * Neither flatpak nor meson support atm building from cargo. @@ -51,7 +51,7 @@ - [ ] 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 +- [ ] 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. @@ -61,7 +61,7 @@ - [ ] Mark stuff as Favorite. Maybe auto-archive favorites? -## Third: +## Third: - [ ] Notifications - [ ] Episode queue @@ -70,8 +70,8 @@ - [ ] Search Implementation -## Fourth: +## Fourth: -- [ ] soundcloud and itunes feeds // [This](http://getrssfeed.com) seems intresting. +- [ ] soundcloud and itunes feeds // [This](http://getrssfeed.com) seems intresting. - [ ] Integrate with Itunes API for various crap - [ ] YoutubeFeeds \ No newline at end of file