summaryrefslogtreecommitdiff
path: root/README.md
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 /README.md
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.
Diffstat (limited to 'README.md')
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
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/