Commit Graph

17 Commits

Author SHA1 Message Date
Bilal Elmoussaoui
c3cb760412 misc: Use the new mutter.gnome.org URL
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3514>
2024-01-12 10:48:20 +00:00
Sebastian Wick
dedc2766d2 docs: Add Building and Running topic
There are a lot of ways to build and run mutter. Let's try to document
them and reduce the tribal knowledge.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3465>
2024-01-03 20:54:57 +00:00
Sebastian Wick
9682ea496c README: Mention the GNOME Handbook Development page
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3465>
2024-01-03 20:54:57 +00:00
Sebastian Wick
edfd1880c9 docs: Move the gitlab wiki and other docs to the docs/ directory
Let's try to consolidate our documentation in doc/ in the repo. This
includes some documentation from README.md, the HACKING.md coding style
and the gitlab wiki.

The README.md file now links to all top-level topics (i.e. not reachable
via other topics).

This also includes a few small changes to make things more consistent.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3465>
2024-01-03 20:54:57 +00:00
Bilal Elmoussaoui
00a6fcb64d readme: Add Mtk docs link
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/3227>
2023-09-02 10:50:47 +00:00
Jonas Ådahl
734b72099a readme: Expand how to tag commit messages
It's a common mistake that links to issues being resolved are not URLs,
and that Part-of was added manually by contributors. Make it clear what
the expectations are regarding this. Formalize on `Fixes:` for fixing
commit messages, and `Closes:` for closing issues while at it. Format
and alias for generating `Fixes:` tags come from mesa.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2847>
2023-03-03 23:17:26 +00:00
Julia Johannesen
b9fc741660 readme: Fix typo
"af" -> "of"

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2542>
2022-07-29 16:52:12 -04:00
Bilal Elmoussaoui
5bbc8ffaa6 readme: Add links to the API documentation
Fixes #341

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/2455>
2022-06-14 15:15:08 +00:00
Florian Müllner
7862f14393 docs: Add README section for default branch
We are about to change it, so briefly outline how to update local
checkouts.

(Copied from glib)

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1930>
2021-07-18 23:14:16 +02:00
Georges Basile Stavracas Neto
a466738945 project: Add HACKING.md
Document the current code style in HACKING.md, and refer to it
in README.md.

Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1900>
2021-06-29 17:29:49 -03:00
Ivan Molodetskikh
acbaccd5c9 README: Fix list paragraphs
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1770>
2021-03-10 09:01:50 +03:00
Jonas Ådahl
dcbd96df38 README: Clarify how to name flag types
Part-of: <https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1765>
2021-03-09 20:52:16 +00:00
Jonas Ådahl
8fb30e6ec5 README: Elaborate coding style and commit message guidelines
Spell out some conventions used in the README.

https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1521
2020-10-28 07:28:55 +00:00
Jonas Ådahl
5ab187da70 README: Add link to wiki
The wiki has gotten a few pages recently, lets link to it.

https://gitlab.gnome.org/GNOME/mutter/-/merge_requests/1521
2020-10-28 07:28:55 +00:00
Jonas Ådahl
f3dd97e67b README: Add contribution section
Short and incomplete blurb about coding style and commit message
guidelines.

https://gitlab.gnome.org/GNOME/mutter/merge_requests/440
2019-02-14 15:38:46 +01:00
Peter Uithoven
4a7a803c34 README: Mention usage by Gala 2018-11-08 17:11:27 +01:00
Jonas Ådahl
eb0865fe11 Add README.md
The welcome page on Gitlab is pretty boring for mutter. Improve that a
bit by adding a README file with some basic introduction.

Fixes: https://gitlab.gnome.org/GNOME/mutter/issues/245
2018-07-30 21:58:59 +02:00