summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNiels De Graef <nielsdegraef@gmail.com>2018-07-22 10:38:24 +0200
committerNiels De Graef <nielsdegraef@gmail.com>2018-07-22 10:39:57 +0200
commit379763651272b724789d920e7e022408ab393a39 (patch)
treeac52e3d4be464dd98053e3e87c9516b473d64dd2
parent47d6a70fab15cad094b90775f55dfbec80b38dc5 (diff)
downloadgdm-379763651272b724789d920e7e022408ab393a39.tar.gz
Update README, use Markdown.
Remove unnecessary files with obsolete links. Remove instructions from HACKING, as they contained old versions of dependencies. It is now only a coding style guide.
-rw-r--r--ChangeLog11
-rw-r--r--HACKING42
-rw-r--r--README32
-rw-r--r--README.md43
-rw-r--r--TODO0
5 files changed, 44 insertions, 84 deletions
diff --git a/ChangeLog b/ChangeLog
deleted file mode 100644
index a39b5492..00000000
--- a/ChangeLog
+++ /dev/null
@@ -1,11 +0,0 @@
-To see the development history of this module, please visit:
-
-http://git.gnome.org/cgit/gdm
-
-or run
-
-git clone git://git.gnome.org/gdm
-
-followed by
-
-git log
diff --git a/HACKING b/HACKING
index 9c3c28f1..14b5e3d4 100644
--- a/HACKING
+++ b/HACKING
@@ -1,43 +1,3 @@
-Building
-========
-
-Dependencies
-
- * glib 2.12 or later
- * D-Bus 1.0 and Glib bindings
- * PAM
- * ConsoleKit 0.2.3
- * gnome-vfs (for file monitoring in greeter)
-
-Getting From SVN
-
-To get the very latest copy you'll need to pull it from SVN. Here's
-how you'll do it.
-
-svn co http://svn.gnome.org/svn/gdm/trunk gdm
-
-
-Browse the code in SVN: http://svn.gnome.org/viewcvs/gdm/trunk/
-
-Making Changes
-==============
-
- * Patches must be submitted in unified diff form. Using the "-p"
- option is strongly preferred.
-
- See:
- http://www.xenomai.org/index.php/Teaching_-p_to_svn_diff
-
- * All but the most trivial patches must be submitted to GNOME
- bugzilla or the GDM mailing list <gdm-list@gnome.org> for approval.
-
- * Patches must apply cleanly to SVN trunk.
-
- * Patches should not introduce additional compilation warnings.
-
- * Patches must use the GDM Coding Style.
-
-
Coding Style
============
@@ -83,4 +43,4 @@ Coding Style
* Prefer glib functions over native ones when available.
* Use glib string handling functions when possible.
- * When in doubt copy the style of the rest of the file. \ No newline at end of file
+ * When in doubt copy the style of the rest of the file.
diff --git a/README b/README
deleted file mode 100644
index f8dcf728..00000000
--- a/README
+++ /dev/null
@@ -1,32 +0,0 @@
-
-GDM - GNOME Display Manager
-http://wiki.gnome.org/Projects/GDM/
-
-The GNOME Display Manager is a system service that is responsible for
-providing graphical log-ins and managing local and remote displays.
-
-
-Installation
-============
-
-See the file 'INSTALL'.
-
-
-How to report bugs
-==================
-
-Bugs should be reported to the GNOME bug tracking
-system:
- http://bugzilla.gnome.org/enter_bug.cgi?product=gdm
-
-You will need to create an account if you don't have one already.
-
-Please read the following page on how to prepare a useful
-bug report:
- https://bugzilla.gnome.org/page.cgi?id=bug-writing.html
-
-
-How to submit patches
-=====================
-
-See the file 'HACKING'.
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..38dd80eb
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+GDM - GNOME Display Manager
+===========================
+http://wiki.gnome.org/Projects/GDM/
+
+The GNOME Display Manager is a system service that is responsible for
+providing graphical log-ins and managing local and remote displays.
+
+## Building and installing
+To build and install GDM from source, just execute the following commands:
+
+```
+$ ./autogen.sh
+$ ./configure
+$ make
+$ sudo make install
+```
+
+## Contributing
+You can browse the code, issues and more at GDM's [GitLab repository].
+
+If you find a bug in GDM, please file an issue on the [issue tracker]. Please
+try to add reproducible steps and the relevant version of GDM.
+
+If you want to contribute functionality or bug fixes, please open a Merge
+Request (MR). For more info on how to do this, see GitLab's [help pages on
+MR's]. Please also follow the GDM coding style, which is documented in
+`HACKING`.
+
+If GDM is not translated in your language or you believe that the
+current translation has errors, you can join one of the various translation
+teams in GNOME. Translators do not commit directly to Git, but are advised to
+use our separate translation infrastructure instead. More info can be found at
+the [translation project wiki page].
+
+## Licensing
+GDM is licensed under the GNU General Public License v2.0. For more info, see
+the `COPYING` file.
+
+
+[help pages on MR's]: https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html
+[GitLab repository]: https://gitlab.gnome.org/GNOME/gdm
+[issue tracker]: https://gitlab.gnome.org/GNOME/gdm/issues
+[translation project wiki page]: https://wiki.gnome.org/TranslationProject/
diff --git a/TODO b/TODO
deleted file mode 100644
index e69de29b..00000000
--- a/TODO
+++ /dev/null