Update README
This commit is contained in:
parent
e497f73316
commit
482ed7c3c6
29
README.md
29
README.md
@ -15,22 +15,10 @@
|
|||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
As of January 19 2018, Hammond can be built and run with [Gnome Builder](https://wiki.gnome.org/Apps/Builder) Nightly
|
Hammond can be built and run with [Gnome Builder](https://wiki.gnome.org/Apps/Builder) >= 3.28.
|
||||||
and any Stable release of Gnome Builder >= 3.28.0.
|
|
||||||
|
|
||||||
Get Builder [here](https://wiki.gnome.org/Apps/Builder/Downloads)
|
Get Builder [here](https://wiki.gnome.org/Apps/Builder/Downloads)
|
||||||
|
|
||||||
Manually:
|
|
||||||
|
|
||||||
The following steps assume you have a working installation of rustc and cargo.
|
|
||||||
If you dont take a look at [rustup.rs](https://rustup.rs/)
|
|
||||||
|
|
||||||
```sh
|
|
||||||
git clone https://gitlab.gnome.org/alatiera/hammond.git
|
|
||||||
cd Hammond/
|
|
||||||
cargo run -p hammond-gtk --release
|
|
||||||
```
|
|
||||||
|
|
||||||
## Broken Feeds
|
## Broken Feeds
|
||||||
|
|
||||||
Found a feed that does not work in Hammond?
|
Found a feed that does not work in Hammond?
|
||||||
@ -45,6 +33,8 @@ Note:
|
|||||||
|
|
||||||
There isn't much documentation yet, so you will probably have question about parts of the Code.
|
There isn't much documentation yet, so you will probably have question about parts of the Code.
|
||||||
|
|
||||||
|
## Building
|
||||||
|
|
||||||
### Flatpak
|
### Flatpak
|
||||||
|
|
||||||
Flatpak is the reccomended way of building and installing Hammond.
|
Flatpak is the reccomended way of building and installing Hammond.
|
||||||
@ -66,7 +56,7 @@ flatpak-builder --user --repo=repo hammond org.gnome.Hammond.json --force-clean
|
|||||||
flatpak build-bundle repo hammond org.gnome.Hammond
|
flatpak build-bundle repo hammond org.gnome.Hammond
|
||||||
```
|
```
|
||||||
|
|
||||||
## Building from soure
|
### Building from soure
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
git clone https://gitlab.gnome.org/alatiera/hammond.git
|
git clone https://gitlab.gnome.org/alatiera/hammond.git
|
||||||
@ -79,7 +69,7 @@ make && sudo make install
|
|||||||
|
|
||||||
You can run `sudo make uninstall` for removal
|
You can run `sudo make uninstall` for removal
|
||||||
|
|
||||||
### Dependencies
|
#### Dependencies
|
||||||
|
|
||||||
* Rust stable 1.22 or later.
|
* Rust stable 1.22 or later.
|
||||||
* Gtk+ 3.22 or later
|
* Gtk+ 3.22 or later
|
||||||
@ -99,13 +89,8 @@ apt-get install -yqq --no-install-recommends libgtk-3-dev meson
|
|||||||
dnf install -y gtk3-devel glib2-devel openssl-devel sqlite-devel meson
|
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.
|
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
|
|
||||||
```
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user