[gjs: 1/2] doc: Update Home
- From: Philip Chimento <pchimento src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gjs: 1/2] doc: Update Home
- Date: Sat, 13 Aug 2022 20:36:24 +0000 (UTC)
commit ce54c2a18731280786cc505d6c3f63b88099a69c
Author: Sonny Piers <sonny sonny re>
Date: Sat Aug 13 20:36:23 2022 +0000
doc: Update Home
README.md | 5 +++--
doc/Home.md | 30 +++++++++++++++++++++++++-----
2 files changed, 28 insertions(+), 7 deletions(-)
---
diff --git a/README.md b/README.md
index 0f0fe31ea..12fe00793 100644
--- a/README.md
+++ b/README.md
@@ -14,8 +14,9 @@ GJS is a JavaScript runtime built on
the [GNOME platform libraries](https://developer.gnome.org/).
Use the GNOME platform libraries in your JavaScript programs.
-GJS powers GNOME Shell, Maps, Characters, Sound Recorder and
-[many other apps](./doc/Home.md).
+GJS powers GNOME Shell, Maps, Characters, Sound Recorder and many other apps.
+
+If you would like to learn more or get started with GJS, head over to the [documentation](./doc/Home.md).
## Installation
diff --git a/doc/Home.md b/doc/Home.md
index 010728586..ec39d9494 100644
--- a/doc/Home.md
+++ b/doc/Home.md
@@ -11,25 +11,40 @@ GJS includes some built-in modules like Cairo and Gettext, as well as helpers fo
[gjs-news]: https://gitlab.gnome.org/GNOME/gjs/raw/HEAD/NEWS
[mdn-polyfills]: https://developer.mozilla.org/docs/Glossary/Polyfill
-## GNOME API Documentation
+## Documentation
There is official [GNOME API Documentation][gjs-docs] for GJS, including
everything from GLib and Gtk to Soup and WebKit2.
The [Mapping](Mapping.md) page has an overview of GNOME API usage in GJS such as subclassing, constants and
flags, functions with multiple return values, and more.
+Additional GJS documentation can be found under [doc](.).
+
+[GJS Guide](gjs-guide) contains tutorials for begineers.
+
+[GTK4 + GJS Book](https://rmnvgr.gitlab.io/gtk4-gjs-book/) is a start to finish walkthrough for the creation
of GTK4 + GJS applications.
+
+The main [GNOME developer portal][gnome-developer] contains numerous examples in JavaScript for GJS.
+
There are also a growing number of [examples][gjs-examples] and thorough tests of language features in the
[test suite][gjs-tests].
[gjs-docs]: https://gjs-docs.gnome.org/
[gjs-examples]: https://gitlab.gnome.org/GNOME/gjs/tree/HEAD/examples
[gjs-tests]: https://gitlab.gnome.org/GNOME/gjs/blob/HEAD/installed-tests/js
+[gjs-guide]: https://gjs.guide/
+[gnome-developer]: https://developer.gnome.org/
+
+## Applications
+
+GJS is a great option to write applications for the GNOME Desktop.
-## Standalone Applications
+The easiest way to get started is to use [GNOME Builder](gnome-builder), start a new project and select
`JavaScript` language.
-It's possible to write standalone applications with GJS for the GNOME Desktop, and infrastructure for
Gettext, GSettings and GResources via the `package` import. There is a package specification, template
repository available and plans for an in depth tutorial.
+There is a also a [package specification] and [template repository] available.
-* [GJS Package Specification](https://gitlab.gnome.org/GNOME/gjs/-/blob/HEAD/doc/Package/Specification.md)
-* [GJS Package Template](https://github.com/gcampax/gtk-js-app)
+[gnome-builder]: https://apps.gnome.org/app/org.gnome.Builder/
+[package specification]: https://gitlab.gnome.org/GNOME/gjs/-/blob/HEAD/doc/Package/Specification.md
+[template repository]: https://github.com/gcampax/gtk-js-app
GNOME Applications written in GJS:
@@ -54,6 +69,11 @@ Third party applications written in GJS:
* [Commit](https://github.com/sonnyp/commit/)
* [Junction](https://github.com/sonnyp/Junction)
* [Oh My SVG](https://github.com/sonnyp/OhMySVG)
+* [Lobjur](https://github.com/ranfdev/Lobjur)
+* [Touché](https://github.com/JoseExposito/touche)
+* [Annex](https://github.com/andyholmes/annex)
+* [Bolso](https://github.com/felipeborges/bolso)
+* [Workbench](https://github.com/sonnyp/Workbench)
## Getting Help
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]