Commit 9c24ef04 authored by Christopher Davis's avatar Christopher Davis

README: Use detailed markdown README

Previously we had a sparse README that just pointed to the
wiki. While wikis are great, the README is where effort
should be put for a first impression.

Added some useful links, tutorials, and communication tips
for potential contributors.
parent e5d49d19
Pipeline #64697 passed with stage
in 14 minutes and 33 seconds
Documents is a document manager application for GNOME.
More information on https://wiki.gnome.org/Apps/Documents
# GNOME Documents
A document manager application for GNOME.
<a href='https://flathub.org/apps/details/org.gnome.Documents'><img width='240' alt='Download on Flathub' src='https://flathub.org/assets/badges/flathub-badge-i-en.png'/></a>
## Useful links
**Homepage**: https://wiki.gnome.org/Apps/Documents
**Report issues**: https://gitlab.gnome.org/GNOME/gnome-documents/issues/
**Donate**: https://www.gnome.org/friends/
**Translate**: https://wiki.gnome.org/TranslationProject
## Hacking on Documents
To start working on Documents see the [general guide](https://wiki.gnome.org/Newcomers/BuildProject) for building GNOME apps
with Flatpak and GNOME Builder. Then, [find a task](https://gitlab.gnome.org/GNOME/gnome-documents/issues?label_name%5B%5D=4.+Newcomers) to work on.
If you're unfamiliar with GJS, here are a few good places to start:
* The [beginner-level guide](https://gjs-guide.gitlab.io/) for working with GJS
* An overview of [working with GNOME APIs via GJS](https://gitlab.gnome.org/GNOME/gjs/wikis/Mapping)
* The [documentation for various GNOME libraries](https://devdocs.baznga.org/) in JavaScript
## Communication
If you need help, contact us at [#gnome-documents:disroot.org](https://matrix.to/#/#gnome-documents:disroot.org) on Matrix. If you need a client,
we recommend using [Fractal](https://flathub.org/apps/details/org.gnome.Fractal), a Matrix app built for GNOME.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment