summaryrefslogtreecommitdiff
path: root/README.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Update the README a littlePhilip Withnall2021-12-091-11/+26
| | | | Signed-off-by: Philip Withnall <withnall@endlessm.com>
* docs: Add API documentation links to the READMEPhilip Withnall2021-12-081-0/+8
| | | | | | | Might make the API documentation a little easier to find from the GitLab landing page for GLib. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
* docs: Mention the stable/unstable support version in README.mdPhilip Withnall2021-06-181-0/+8
| | | | Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
* docs: Add a section to the README about the branch renamePhilip Withnall2021-06-071-0/+13
| | | | | | Signed-off-by: Philip Withnall <pwithnall@endlessos.org> Helps: #2348
* docs: Move ‘Notes’ section from README to NEWSPhilip Withnall2021-01-131-284/+0
| | | | | | | | | | The content of the section was more appropriate to the `NEWS` file, and no longer helpful for anyone reading the `README`. The `README` is meant to be a quick introduction to the project and how to contribute to it, not a set of notes for packagers and distributors. That’s what `NEWS` is. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
* tree: Fix various typos and outdated terminologyPhilip Withnall2020-06-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | This was mostly machine generated with the following command: ``` codespell \ --builtin clear,rare,usage \ --skip './po/*' --skip './.git/*' --skip './NEWS*' \ --write-changes . ``` using the latest git version of `codespell` as per [these instructions](https://github.com/codespell-project/codespell#user-content-updating). Then I manually checked each change using `git add -p`, made a few manual fixups and dropped a load of incorrect changes. There are still some outdated or loaded terms used in GLib, mostly to do with git branch terminology. They will need to be changed later as part of a wider migration of git terminology. If I’ve missed anything, please file an issue! Signed-off-by: Philip Withnall <withnall@endlessm.com>
* adjust formattingRoger2019-08-301-54/+30
|
* docs: Remove mentions of mailing listsEmmanuele Bassi2019-07-231-14/+6
| | | | | And drop FTP from the list of places where to find release archives. This is not 1998.
* docs: Rename README.in to README.md for GitLabPhilip Withnall2018-06-151-0/+365
There seems to be little point in substituting the version number into README (using autotools). Rename it to README.md and distribute that verbatim (with autotools and Meson) instead. Autotools still requires that README exists, so leave a stub README file in place which redirects people to README.md. This can be dropped when we drop autotools support. Signed-off-by: Philip Withnall <withnall@endlessm.com>