Migrate README to markdown

This commit is contained in:
Gaurav Agrawal 2018-11-04 23:55:08 +01:00 committed by Alberto Fanjul
parent 358f5ec7e9
commit e90f066765
2 changed files with 42 additions and 41 deletions

41
README
View file

@ -1,41 +0,0 @@
= General Information =
gitg is a graphical user interface for git. It aims at being a small,
fast and convenient tool to visualize the history of git repositories.
Besides visualization, gitg also provides several utilities to manage your
repository and commit your work.
The latest version of gitg is 3.30.1.
Website: https://wiki.gnome.org/Apps/Gitg
Bugs: https://bugzilla.gnome.org/browse.cgi?product=gitg
Download: http://download.gnome.org/sources/gitg/
Mailing list: http://mail.gnome.org/mailman/listinfo/gitg-list
= Installing gitg =
To install the latest version of gitg, make sure to download gitg-3.30.1.tar.xz
from the download site. After downloading the following procedure installs
gitg:
$ tar Jxf gitg-3.30.1.tar.xz
$ cd gitg-3.30.1
$ meson --prefix=/usr build
$ ninja -C build
$ sudo ninja -C install
For more information on installing gitg, please see INSTALL.
= Building gitg from git =
The gitg repository is hosted on git.gnome.org. To build from git:
$ git clone http://gitlab.gnome.org/GNOME/gitg.git
$ cd gitg
$ meson --prefix=/usr build
$ ninja -C build
$ sudo ninja -C install
Alternatively you can build using Flatpak with the org.gnome.Gitg.json manifest.
= Using gitg =
When gitg is installed, you can run gitg from the GNOME menu, or from a
terminal by issueing: 'gitg'. Type 'gitg --help' to show the options you can
specify on the command line.

42
README.md Normal file
View file

@ -0,0 +1,42 @@
# Gitg
gitg is a graphical user interface for git. It aims at being a small, fast and convenient tool to visualize the history of git repositories. Besides visualization, gitg also provides several utilities to manage your repository and commit your work.
The latest version of gitg is 3.30.1.
- Website: https://wiki.gnome.org/Apps/Gitg
- Bugs: https://bugzilla.gnome.org/browse.cgi?product=gitg
- Download: http://download.gnome.org/sources/gitg/
- Mailing list: http://mail.gnome.org/mailman/listinfo/gitg-list
## Installing gitg
To install the latest version of gitg, make sure to download gitg-3.30.1.tar.xz from the download site. After downloading the following procedure installs gitg:
```
$ tar Jxf gitg-3.30.1.tar.xz
$ cd gitg-3.30.1
$ meson --prefix=/usr build
$ ninja -C build
$ sudo ninja -C install
```
For more information on installing gitg, please see INSTALL.
## Building gitg from git
The gitg repository is hosted on git.gnome.org. To build from git:
```
$ git clone http://gitlab.gnome.org/GNOME/gitg.git
$ cd gitg
$ meson --prefix=/usr build
$ ninja -C build
$ sudo ninja -C install
```
Alternatively you can build using Flatpak with the org.gnome.Gitg.json manifest.
## Using gitg
When gitg is installed, you can run gitg from the GNOME menu, or from a terminal by issueing: 'gitg'. Type 'gitg --help' to show the options you can specify on the command line.