Skip to content

Commit

Permalink
Improve the readme with a logo
Browse files Browse the repository at this point in the history
  • Loading branch information
TheElectronWill committed Sep 17, 2017
1 parent 7081a47 commit 311559e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
# RPM Package for Gitkraken
A script to create an RPM package of Gitkraken.
![gitkraken logo](gitkraken-wide.png)

# Gitkraken rpm

Unofficial rpm package for gitkraken.

## How to use
1. Run the [create-package.sh](https://github.com/RPM-Outpost/gitkraken/blob/master/create-package.sh) script from the command line. It will download the latest version of Gitkraken and build an RPM package. You must specify the version of gitkraken, for instance: `./create-package.sh 3.0`
2. Then, install the package with `sudo dnf install <rpm file>`. The script can also install the package for you.
Open a terminal and run `./create-package.sh <gitkraken_version>`, where `<gitkraken_version>` is for instance `3.0.0`.

### Requirements
You need to install the `rpmdevtools` package to build RPM packages and use the script.
Don't worry: the script detects if it isn't installed, and can install it for you.
## Features
- Downloads the latest version of Gitkraken from the official website
- Creates a ready-to-use RPM package
- Adds Gitkraken to the applications' list with a nice HD icon
- Tested on Fedora 25 and 26 (may work on other distributions)

### About the version parameter
The script doesn't detect the latest version of gitkraken, so you have to specify it. I haven't found a way to download a specific gitkraken version, so the script always download the latest version, even if you specified an old version number.
## More informations

### About root privileges
Building an RPM package with root privileges is dangerous, because a mistake in SPEC file could result in running nasty commands.
See http://serverfault.com/questions/10027/why-is-it-bad-to-build-rpms-as-root.
### How to update
When a new version of gitkraken is released, simply run the script again to get the updated version.

## Update Gitkraken
When a new version of Gitkraken is released, you can run the `create-package.sh [version]` script again to create an updated package.
Then install the updated package with `sudo dnf install <rpm file>`.
### Requirements
The `rpmdevtools` package is required to build RPM packages. The script detects if it isn't installed and offers to install it.

## Supported distributions
- Fedora 25
- Fedora 26
### About the version parameter
The script cannot detect the version of gitkraken, that's why you have to specify it. The downloaded version is always the latestone, regardless of what you specified.

It probably work on other RPM-based distros but I haven't tested it. Let me know if it works for you!
### About root privileges
Building an RPM package with root privileges is dangerous, see http://serverfault.com/questions/10027/why-is-it-bad-to-build-rpms-as-root.

## Screenshots
![beautiful screenshot](screenshot1.png)

![screenshot when gitkraken has already been downloaded](screenshot2.png)
Binary file added gitkraken-wide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 311559e

Please sign in to comment.