diff options
author | Philip Chimento <philip.chimento@gmail.com> | 2022-08-13 20:36:23 +0000 |
---|---|---|
committer | Philip Chimento <philip.chimento@gmail.com> | 2022-08-13 20:36:23 +0000 |
commit | e86716d8129156f56d1b0418de8bc9bf0adb5c43 (patch) | |
tree | 02af4da31fd520bc26a30be4ef6c845cd60e11ca | |
parent | 3b48bfab5c50379faa0bd5c0c1329d9d3a43e503 (diff) | |
parent | ce54c2a18731280786cc505d6c3f63b88099a69c (diff) | |
download | gjs-e86716d8129156f56d1b0418de8bc9bf0adb5c43.tar.gz |
Merge branch 'update-home-doc' into 'master'
doc: Update Home
See merge request GNOME/gjs!793
-rw-r--r-- | README.md | 5 | ||||
-rw-r--r-- | doc/Home.md | 30 |
2 files changed, 28 insertions, 7 deletions
@@ -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 01072858..ec39d949 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 |