[gnome-documents] README: Use detailed markdown README
- From: Christopher Davis <christopherdavis src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gnome-documents] README: Use detailed markdown README
- Date: Sun, 3 Mar 2019 09:52:24 +0000 (UTC)
commit 9c24ef0406f5f361db39fade09821d4829709376
Author: Christopher Davis <brainblasted disroot org>
Date: Sun Mar 3 04:46:31 2019 -0500
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.
README | 2 --
README.md | 31 +++++++++++++++++++++++++++++++
2 files changed, 31 insertions(+), 2 deletions(-)
---
diff --git a/README.md b/README.md
new file mode 100644
index 00000000..c5c456e9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,31 @@
+# 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
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]