X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/44207eadd7f8eb9192e128a0108efeb5e7f88009..1abce8eb7d46cfcbb571784260b6882b16b7f9f1:/packages/gnome-c-style/README.md

diff --git a/packages/gnome-c-style/README.md b/packages/gnome-c-style/README.md
index 336a4629f..69532eb35 100644
--- a/packages/gnome-c-style/README.md
+++ b/packages/gnome-c-style/README.md
@@ -1,24 +1,17 @@
 gnome-c-style
 ======
 
-In the C coding style commonly used in GNOME, identifiers are written
-in camel case and function arguments are aligned to the right end.
-That makes it a bit cumbersome to keep your code consistent with the
-style, even with align.el or plugins like yasnippet.
-
-gnome-c-style is an Emacs minor mode intended to help editing C
-source code in that style.  It mainly provides two features: text
-alignment and snippet insersion.
+gnome-c-style is an Emacs minor mode for editing C source code in [GNOME C coding style](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en).
+In particular, it is useful to properly line-up [function arguments](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en#functions) and
+[function declarations in header files](https://developer.gnome.org/programming-guidelines/stable/c-coding-style.html.en#header-files).
 
 Install
 ------
 
-* Type "make"
-* Copy .elc files somewhere in your load-path
-* Add the following lines to ~/.emacs/init.el:
+* `M-x package-install gnome-c-style`
+* Add the following line to `~/.emacs.d/init.el`:
 
 ```
-(autoload 'gnome-c-style-mode "gnome-c-style" "GNOME-style C minor mode" t)
 (add-hook 'c-mode-hook 'gnome-c-style-mode)
 ```
 
@@ -31,10 +24,10 @@ Usage
 | C-c C-g r   | Align function declarations in the current region         |
 | C-c C-g C-g | Compute optimal alignment columns from the current region |
 | C-c C-g g   | Guess alignment columns from the current region           |
-| C-c C-g s   | Set alignment column to the current point                 |
-| C-c C-g c   | Insert ```module_object```                                |
-| C-c C-g C   | Insert ```MODULE_OBJECT```                                |
-| C-c C-g C-c | Insert ```ModuleObject```                                 |
+| C-c C-g f   | Set alignment column to the current point                 |
+| C-c C-g c   | Insert `module_object`                                    |
+| C-c C-g C   | Insert `MODULE_OBJECT`                                    |
+| C-c C-g C-c | Insert `ModuleObject`                                     |
 | C-c C-g s   | Insert custom snippet                                     |
 
 Example
@@ -60,18 +53,18 @@ GGpgKey *g_gpg_ctx_get_signer (GGpgCtx *ctx, guint index);
 void g_gpg_ctx_clear_signers (GGpgCtx *ctx);
 ```
 
-Mark the region, type ```C-c C-g C-g```, and you will see the optimum
+Mark the region, type `C-c C-g C-g`, and you will see the optimum
 alignment columns:
 
 ```
-identifier-start: 9, arglist-start: 41, arglist-identifier-start: 63
+identifier-start: 9, arglist-start: 41, arglist-identifier-start: 64
 ```
 
-Then, mark the region again, type ```C-c C-g r```, and you will get
-the code aligned:
+Then, mark the region again, type `C-c C-g r`, and you will get the
+code aligned:
 
 ```c
-GGpgCtx *g_gpg_ctx_new                   (GError             **error);
+GGpgCtx *g_gpg_ctx_new                   (GError              **error);
 
 typedef void (*GGpgProgressCallback) (gpointer user_data,
                                       const gchar *what,
@@ -79,16 +72,17 @@ typedef void (*GGpgProgressCallback) (gpointer user_data,
                                       gint current,
                                       gint total);
 
-void     g_gpg_ctx_set_progress_callback (GGpgCtx             *ctx,
-                                          GGpgProgressCallback callback,
-                                          gpointer             user_data,
-                                          GDestroyNotify       destroy_data);
-void     g_gpg_ctx_add_signer            (GGpgCtx             *ctx,
-                                          GGpgKey             *key);
-guint    g_gpg_ctx_get_n_signers         (GGpgCtx             *ctx);
-GGpgKey *g_gpg_ctx_get_signer            (GGpgCtx             *ctx,
-                                          guint                index);
-void     g_gpg_ctx_clear_signers         (GGpgCtx             *ctx);
+void     g_gpg_ctx_set_progress_callback (GGpgCtx              *ctx,
+                                          GGpgProgressCallback  callback,
+                                          gpointer              user_data,
+                                          GDestroyNotify        destroy_data);
+void     g_gpg_ctx_add_signer            (GGpgCtx              *ctx,
+                                          GGpgKey              *key);
+guint    g_gpg_ctx_get_n_signers         (GGpgCtx              *ctx);
+GGpgKey *g_gpg_ctx_get_signer            (GGpgCtx              *ctx,
+                                          guint                 index);
+void     g_gpg_ctx_clear_signers         (GGpgCtx              *ctx);
 ```
 
-Note that ```typedef``` is skipped as it is not a function declaration.
+Note that the `typedef` statement is skipped as it is not a function
+declaration.