[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] master 76e929a 05/20: README.md: Use inline code blocks properly
From: |
Daiki Ueno |
Subject: |
[elpa] master 76e929a 05/20: README.md: Use inline code blocks properly |
Date: |
Wed, 10 Feb 2016 08:33:17 +0000 |
branch: master
commit 76e929a64109592d34c7d189a084997c110de655
Author: Daiki Ueno <address@hidden>
Commit: Daiki Ueno <address@hidden>
README.md: Use inline code blocks properly
---
README.md | 21 ++++++++++-----------
1 files changed, 10 insertions(+), 11 deletions(-)
diff --git a/README.md b/README.md
index 7cbb5b3..8e45e48 100644
--- a/README.md
+++ b/README.md
@@ -5,13 +5,11 @@ gnome-c-style is an Emacs minor mode for editing C source
code in [GNOME C codin
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).
-It also provides commands to insert basic snippets.
-
Install
------
-* M-x package-install gnome-c-style
-* Add the following lines to ~/.emacs/init.el:
+* `M-x package-install gnome-c-style`
+* Add the following lines to `~/.emacs/init.el`:
```
(add-hook 'c-mode-hook 'gnome-c-style-mode)
@@ -27,9 +25,9 @@ Usage
| 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 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 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
@@ -55,15 +53,15 @@ 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: 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);
@@ -86,4 +84,5 @@ GGpgKey *g_gpg_ctx_get_signer (GGpgCtx
*ctx,
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.
- [elpa] master updated (c281465 -> 1abce8e), Daiki Ueno, 2016/02/10
- [elpa] master c6d22f9 01/20: Fix links, Daiki Ueno, 2016/02/10
- [elpa] master cca4a06 02/20: Fix keybindings in README.md, Daiki Ueno, 2016/02/10
- [elpa] master 9566ae5 03/20: Fix examples in README.md, Daiki Ueno, 2016/02/10
- [elpa] master 6a18372 04/20: README.md: Use inline code blocks properly, Daiki Ueno, 2016/02/10
- [elpa] master 76e929a 05/20: README.md: Use inline code blocks properly,
Daiki Ueno <=
- [elpa] master 25184d6 06/20: Fix typo in README.md, Daiki Ueno, 2016/02/10
- [elpa] master 79f77aa 07/20: snippet: Fix typo, Daiki Ueno, 2016/02/10
- [elpa] master 34132ba 08/20: README.md: Fix typo, Daiki Ueno, 2016/02/10
- [elpa] master 4cd7696 09/20: align: Expand documentation of align-region, Daiki Ueno, 2016/02/10
- [elpa] master b23b5a3 10/20: snippet: Upcase the first letter of names, Daiki Ueno, 2016/02/10
- [elpa] master df2906e 11/20: snippet: Always require subword, Daiki Ueno, 2016/02/10
- [elpa] master 82c34eb 12/20: snippet: Refactor name prompt, Daiki Ueno, 2016/02/10
- [elpa] master 9db7ee5 13/20: snippet: Support guessing package/class names, Daiki Ueno, 2016/02/10
- [elpa] master 2136dd5 14/20: snippet: Fix for older pcase, Daiki Ueno, 2016/02/10
- [elpa] master f3c2b22 15/20: tests: Add snippt tests, Daiki Ueno, 2016/02/10