[gitg/gnome-3-30] Migrate README to markdown
- From: Alberto Fanjul <albfan src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gitg/gnome-3-30] Migrate README to markdown
- Date: Mon, 5 Nov 2018 00:10:54 +0000 (UTC)
commit 5ee618871571da0ea24d728ab86674da18092eb6
Author: Gaurav Agrawal <agrawalgaurav1999 gmail com>
Date: Sun Nov 4 23:55:08 2018 +0100
Migrate README to markdown
README | 41 -----------------------------------------
README.md | 42 ++++++++++++++++++++++++++++++++++++++++++
2 files changed, 42 insertions(+), 41 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..a680b90d
--- /dev/null
+++ b/README.md
@@ -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.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]