diff options
| author | Philip Chimento <philip.chimento@gmail.com> | 2021-07-23 22:31:34 -0700 |
|---|---|---|
| committer | Philip Chimento <philip.chimento@gmail.com> | 2021-07-24 07:56:23 -0700 |
| commit | 1de70cdbf455ef90aa387cd43c2264b4299e7fa8 (patch) | |
| tree | a479a319c293d3e8a66798be9ca046a41df84c20 | |
| parent | da4c0bb102857dde8e29ddd7fd35cc9be290ac74 (diff) | |
| download | gjs-1de70cdbf455ef90aa387cd43c2264b4299e7fa8.tar.gz | |
docs: Fix out of date details in docs
| -rw-r--r-- | CONTRIBUTING.md | 6 | ||||
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | doc/Home.md | 8 |
3 files changed, 9 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8ab096e8..e22c9ee6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -299,9 +299,9 @@ autoformatter, read the [CPP_Style_Guide.md][cppstyle] file. For Javascript code, an [ESLint configuration file][eslint] is included in the root of the GJS repository. This is not integrated with a git commit hook, so you need to manually -manually sure that all your new code conforms to the style. -Don't rewrite old code with `eslint --fix` unless you are already -changing that code for some other reason. +make sure that all your code conforms to the style. +Running `./tools/run_eslint.sh --fix` should autoformat most of your +JavaScript code correctly. ### Commit messages ### @@ -63,7 +63,7 @@ a forked version, [Cinnamon]. ### Documentation -* [Get started](https://gitlab.gnome.org/GNOME/gjs/-/blob/HEAD/doc/Home.md) +* [Get started](https://gitlab.gnome.org/GNOME/gjs/blob/HEAD/CONTRIBUTING.md) * [Get started - Internship](https://gitlab.gnome.org/GNOME/gjs/blob/HEAD/doc/Internship-Getting-Started.md) * [API documentation](https://gjs-docs.gnome.org/) diff --git a/doc/Home.md b/doc/Home.md index 2870de55..899507df 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -1,6 +1,8 @@ # GJS: Javascript Bindings for GNOME -The current stable series is built on Mozilla's SpiderMonkey 78 featuring **ECMAScript 2019** and GObjectIntrospection making most of the **GNOME API library** available. +The current stable series is built on Mozilla's SpiderMonkey 78, +featuring **ECMAScript 2019** and GObject Introspection making most of +the **GNOME platform API** available. To find out when a language feature was implemented in GJS, review [NEWS][gjs-news] in the GitLab repository. In many cases older versions of GJS can be supported using [polyfills][mdn-polyfills] and [legacy-style GJS classes](Modules.md#lang). @@ -11,7 +13,8 @@ GJS includes some built-in modules like Cairo and Gettext, as well as helpers fo ## GNOME API Documentation -There is now official [GNOME API Documentation][gjs-docs] for GJS, including everything from GLib and Gtk to Soup and WebKit2. +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. @@ -21,7 +24,6 @@ There are also a growing number of [examples][gjs-examples] and thorough tests o [gjs-examples]: https://gitlab.gnome.org/GNOME/gjs/tree/HEAD/examples [gjs-tests]: https://gitlab.gnome.org/GNOME/gjs/blob/HEAD/installed-tests/js - ## Standalone Applications 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. |