[gnome-boxes] docs: Convert README to use the Markdown Syntax



commit 1360b0fd9de38afe10d2dc6698a552267d38470a
Author: Thiago Mendes <thiago posteo de>
Date:   Fri Sep 28 17:39:29 2018 +0200

    docs: Convert README to use the Markdown Syntax
    
     Since Gnome Boxes is now using the Gitlab system the file is now
     updated to use the Markdown Syntax

 README => README.md | 76 +++++++++++++++++++++++++++++++----------------------
 1 file changed, 45 insertions(+), 31 deletions(-)
---
diff --git a/README b/README.md
similarity index 70%
rename from README
rename to README.md
index b2f65d1f..73d35cc4 100644
--- a/README
+++ b/README.md
@@ -1,10 +1,8 @@
-Introduction
-============
+# Introduction
 
 A simple GNOME 3 application to access remote or virtual systems.
 
-Goals
-=====
+# Goals
 
 * View, access, and use:
   * remote machines
@@ -18,32 +16,28 @@ Goals
 * Select favorites
 * Search for connections
 
-Non-Goals
-=========
+# Non-Goals
 
 * Enterprise system management / administration
 * Asset management
 * Software distribution
 * Automation
 
-Use Cases
-=========
+# Use Cases
 
 * Connect to a local virtual machine for testing.
 * Connecting to a work machine from home.
 * Connect to a work machine over a low quality cellular network.
 
-Runtime Dependencies
-====================
+# Runtime Dependencies
 
 * mcopy (usually provided by mtools package)
 
-Reporting Bugs
-==============
+# Reporting Bugs
 
 If you want to report bugs, please check if there isn't already one on:
 
- https://gitlab.gnome.org/GNOME/gnome-boxes/issues
+ [GNOME Boxes Issues](https://gitlab.GNOME.org/GNOME/GNOME-boxes/issues)
 
 If one does not exist already, please file a new one.
 
@@ -60,48 +54,68 @@ include
 The determination of what is useful is your task. If you forget about
 something important, someone will probably ask.
 
-Appendix
-========
+# Appendix
 
-1. Backtracing
---------------
-just run
+## Backtracing
 
- jhbuild run gdb gnome-boxes
+* If you are not using the flatpak gnome-boxes package
+
+```
+gdb gnome-boxes
+```
+
+* If you using the flatpak gnome-boxes package
+
+```
+flatpak run --command=sh --devel org.gnome.Boxes
+gdb /app/bin/gnome-boxes
+```
 
 Type
 
- run
+```
+run
+```
 
 Let the program crash.
+
 Type:
 
- backtrace
+```
+backtrace
+```
 
 And copy the output to pastebin.com or a similar webpage and link it in the
 bugtracker with a hint.
 
-2. Activating debug messages
-----------------------------
+## Activating debug messages
+
 To run Boxes with debug message output on the console, just run:
 
- G_MESSAGES_DEBUG=Boxes gnome-boxes
+```
+G_MESSAGES_DEBUG=Boxes GNOME-boxes
+```
 
 If you want to run your jhbuild version, execute:
 
- G_MESSAGES_DEBUG=Boxes jhbuild run gnome-boxes
+```
+G_MESSAGES_DEBUG=Boxes jhbuild run GNOME-boxes
+```
 
 or start a shell under jhbuild environment:
 
- G_MESSAGES_DEBUG=Boxes jhbuild shell
+```
+G_MESSAGES_DEBUG=Boxes jhbuild shell
+```
 
 to be able to use simpler commands from there:
 
- gnome-boxes
+```
+GNOME-boxes
+```
 
-3. References
--------------
+## References
 
-* https://wiki.gnome.org/ThreePointThree/Features/Boxes
-* https://wiki.gnome.org/Design/Apps/Boxes
+* [GNOME Boxes](https://wiki.GNOME.org/ThreePointThree/Features/Boxes)
+* [GNOME Boxes Wiki](https://wiki.GNOME.org/Design/Apps/Boxes)
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]