branch: master commit 277e10c77d66ffaa5803a6a40c61b26b8efd73a6 Merge: 3f08b2b 7c6fab2 Author: Clément Pit--Claudel <clement.pitclau...@live.com> Commit: Clément Pit--Claudel <clement.pitclau...@live.com>
Merge pull request #113 from rocky/logo New RealGUD logo --- README.md | 22 ++++----- etc/realgud-logo-square.png | Bin 0 -> 12137 bytes etc/realgud-logo.png | Bin 0 -> 13173 bytes etc/realgud-logo.svg | 106 +++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 116 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b4e972a..b9f2fd0 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,13 @@ [![MELPA][melpa-image]][melpa] [![MELPA Stable][melpa-stable-image]][melpa-stable] -# RealGUD + **A modular GNU Emacs front-end for interacting with external debuggers**, brought to you by **Rocky Bernstein** ([@rocky](https://github.com/rocky)) and **Clément Pit-Claudel** ([@cpitclaudel](https://github.com/cpitclaudel)).  -## Setup - -### Installation +# Setup You can install RealGUD from [MELPA](http://melpa.org/#/getting-started), a repository of Emacs packages. If you don't have MELPA set up, add the following to your `.emacs` and restart Emacs: @@ -29,19 +27,19 @@ M-x package-install RET realgud RET (to install and compile `realgud` and its Alternatively, you can install RealGUD using [el-get](http://www.emacswiki.org/emacs/el-get) or from source directly. See [this article](https://github.com/rocky/emacs-dbgr/wiki/How-to-Install) in our wiki for more info. -## Quick start +# Quick start Use `M-x load-library RET realgud RET` to load RealGUD. -### Launching the debugger +## Launching the debugger Open a source file, then use `M-x realgud:<debugger-name>` to start your favorite debugger (for example, you can use `M-x realgud:pdb` to launch PDB, a Python debugger). RealGUD opens two windows: the *command window* (showing the debugger's REPL), and the *source window*, showing your code (with some debuggers, such as `realgud:gdb`, this window does not appear until you type `start` in the *command window*). An solid arrow `▶` indicates the current line in the source window. Grayed [...] -### Using the debugger +## Using the debugger All usual debugger commands work in the command window: for example, you can type `n RET` in the command window to step forward one source line. But RealGUD's power lies in the source window: in it, most single keys correspond to a debugger action. For example, you can press `n` in the source window to step forward. -### Source window commands +## Source window commands Here is a quick rundown of the most useful commands. “🐁” indicates mouse commands (commands that can be run by clicking on a variable or in the margins). Many of the commands are accessible from the tool bar (`tool-bar-mode`) and the menu (`menu-bar-mode`). @@ -76,13 +74,13 @@ Here is a quick rundown of the most useful commands. “🐁” indicates mouse | <kbd>R</kbd>, <kbd>r</kbd> | Run (aka “restart”) | | <kbd>S</kbd> | Go to command window | -## Supported debuggers +# Supported debuggers RealGUD supports [many external debuggers](https://github.com/rocky/emacs-dbgr/wiki/Debuggers-Supported). Help us [support even more](https://github.com/rocky/emacs-dbgr/wiki/How-to-add-a-new-debugger)! -## Advanced topics +# Advanced topics -### Extra commands +## Extra commands “⚙” indicates a work-in-progress (contributions welcome!) @@ -95,7 +93,7 @@ RealGUD supports [many external debuggers](https://github.com/rocky/emacs-dbgr/w | <kbd>-</kbd> | Disable breakpoint ⚙ | | <kbd>+</kbd> | Enable breakpoint ⚙ | -### Tracking an existing debugger process +## Tracking an existing debugger process Use `M-x realgud-track-mode` inside an existing [shell](http://www.gnu.org/software/emacs/manual/html_node/emacs/Shell.html), or [eshell](https://www.gnu.org/software/emacs/manual/html_mono/eshell.html) buffer to track an already-running debugger process. diff --git a/etc/realgud-logo-square.png b/etc/realgud-logo-square.png new file mode 100644 index 0000000..9667399 Binary files /dev/null and b/etc/realgud-logo-square.png differ diff --git a/etc/realgud-logo.png b/etc/realgud-logo.png new file mode 100644 index 0000000..d9f0423 Binary files /dev/null and b/etc/realgud-logo.png differ diff --git a/etc/realgud-logo.svg b/etc/realgud-logo.svg new file mode 100644 index 0000000..99ad3fc --- /dev/null +++ b/etc/realgud-logo.svg @@ -0,0 +1,106 @@ +<?xml version="1.0" encoding="UTF-8" standalone="no"?> +<svg + xmlns:dc="http://purl.org/dc/elements/1.1/" + xmlns:cc="http://creativecommons.org/ns#" + xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" + xmlns:svg="http://www.w3.org/2000/svg" + xmlns="http://www.w3.org/2000/svg" + xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" + xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" + xml:space="preserve" + id="svg4768" + viewBox="0.171 0.201 2880.0002 640" + height="60" + width="270" + version="1.0" + inkscape:version="0.91 r" + sodipodi:docname="realgud.svg" + inkscape:export-filename="/home/clement/desktop/realgud.png" + inkscape:export-xdpi="180" + inkscape:export-ydpi="180"><sodipodi:namedview + pagecolor="#ffffff" + bordercolor="#666666" + borderopacity="1" + objecttolerance="10" + gridtolerance="10" + guidetolerance="10" + inkscape:pageopacity="0" + inkscape:pageshadow="2" + inkscape:window-width="1920" + inkscape:window-height="1030" + id="namedview72" + showgrid="false" + inkscape:zoom="4" + inkscape:cx="115.47042" + inkscape:cy="38.714008" + inkscape:window-x="0" + inkscape:window-y="0" + inkscape:window-maximized="1" + inkscape:current-layer="svg4768" + fit-margin-top="3" + fit-margin-left="3" + fit-margin-right="3" + fit-margin-bottom="3" /> +<!-- Parts of this image extracted from GNU Emacs' icon (the white wave-like shape) --> +<defs + id="defs4770" /><rect + style="display:none;fill:none" + id="rect4772" + y="101.52715" + x="-665.96661" + height="512" + width="512" /><g + style="display:none" + id="g4788" + transform="translate(-666.13763,101.32614)"><g + style="display:inline" + id="g4790" /></g><g + style="display:none" + id="g4806" + transform="translate(-666.13763,101.32614)"><g + style="display:inline" + id="g4808"><path + style="display:none;fill:#050505" + id="path4810" + d="m 349.098,256.651 c -0.265,-0.254 37.637,27.605 39.421,25.012 6.362,-9.252 82.046,-93.137 84.784,-116.236 0.242,-2.003 -0.516,-4.096 -0.516,-4.096 0,0 -1.19,-0.144 -6.325,-4.314 -2.692,-2.192 -5.483,-4.581 -5.483,-4.581 -16.054,0.998 -57.885,41.559 -111.062,103.568" + inkscape:connector-curvature="0" /></g></g><text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:688.39953613px;line-height:125%;font-family:Ubuntu;-inkscape-font-specification:'Ubuntu Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="-25.458374" + y="569.73444" + id="text3492" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3494" + x="-25.458374" + y="569.73444" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-family:Ubuntu;-inkscape-font-specification:'Ubuntu Medium';fill:#000000">R</tspan></text> +<g + id="g3515" + transform="matrix(0.89624184,0,0,0.89624184,406.60585,174.82476)" + inkscape:export-xdpi="349.85999" + inkscape:export-ydpi="349.85999"><path + style="opacity:1;fill:#000000;fill-opacity:1;stroke:none;stroke-width:13.33816814;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + id="path4235-9" + d="m 501.09769,256.201 c 0,136.65118 -109.6574,247.42885 -244.92663,247.42885 -135.26924,0 -244.92675,-110.77767 -244.92675,-247.42886 0,-136.6512 109.65751,-247.4288435 244.92675,-247.4288435 135.26923,0 244.92663,110.7776435 244.92663,247.4288435 z" + inkscape:connector-curvature="0" /><path + style="opacity:1;fill:#a40000;fill-opacity:1;stroke:#ffffff;stroke-width:13.33816814;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + id="path4235" + d="m 489.28614,256.20099 c 0,130.06122 -104.36919,235.49665 -233.11509,235.49665 -128.7459,0 -233.1152,-105.43543 -233.1152,-235.49665 0,-130.06122 104.3693,-235.496645 233.1152,-235.496645 128.7459,0 233.11509,105.435425 233.11509,235.496645 z" + inkscape:connector-curvature="0" /><path + style="fill:#ffffff;fill-opacity:1;fill-rule:evenodd;stroke:#000000;stroke-width:0;stroke-linecap:butt;stroke-linejoin:miter;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" + id="path4237" + d="m 175.0003,422.31057 c 0,0 19.7385,1.39634 45.1312,-0.84159 10.2834,-0.9063 49.3267,-4.74128 78.5169,-11.14289 0,0 35.5899,-7.61669 54.6301,-14.63335 19.9225,-7.34185 30.7636,-13.57304 35.6433,-22.40243 -0.2128,-1.80907 1.5024,-8.22438 -7.685,-12.07788 -23.4887,-9.85199 -50.73,-8.06998 -104.6338,-9.21285 -59.7772,-2.05391 -79.6627,-12.05971 -90.2556,-20.11838 -10.1579,-8.17519 -5.05,-30.79254 38.4742,-50.71499 21.9244,-10.60898 107.8705,-30.18698 107.8705,-30.18698 -28.9451,-14 [...] + inkscape:connector-curvature="0" /></g><text + xml:space="preserve" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-size:688.3994751px;line-height:125%;font-family:Ubuntu;-inkscape-font-specification:'Ubuntu Medium';letter-spacing:0px;word-spacing:0px;fill:#000000;fill-opacity:1;stroke:none;stroke-width:1px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1" + x="860.70557" + y="569.73444" + id="text3492-3" + sodipodi:linespacing="125%"><tspan + sodipodi:role="line" + id="tspan3494-6" + x="860.70557" + y="569.73444" + style="font-style:normal;font-variant:normal;font-weight:500;font-stretch:normal;font-family:Ubuntu;-inkscape-font-specification:'Ubuntu Medium';fill:#000000">alGUD</tspan></text> +</svg>