[dia/neduard/update_readme] #30 Update markdown.

[Eduard Nicodei <neduard src gnome org>]

commit 93b1ac4917b79672da5bb622f515fe2a5bbbfc52
Author: Eduard Nicodei <eddnicodei gmail com>
Date:   Wed Jan 30 15:32:20 2019 +0000

    #30 Update markdown.
    
     - Minor tweaks to README and HACKING.

 HACKING.md | 39 +++++++++++++++++----------------------
 README.md  | 32 ++++++++++++++++----------------
 2 files changed, 33 insertions(+), 38 deletions(-)
---
diff --git a/HACKING.md b/HACKING.md
index dcdf387e..76ee96ea 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -1,3 +1,4 @@
+# Intro
 Feel free to hack away at dia, but you're advised to contact
 the dia maintainers and/or the mailing list if you do any
 larger work --- this is in everyone's interest so that work is
@@ -6,20 +7,16 @@ not duplicated.
 For more information on the authors, maintainers, etc., of dia,
 please see the file AUTHORS (dynamically generated).
 
-Visit the dia webpage at http://www.gnome.org/projects/dia/
+Visit the dia webpage at https://gitlab.gnome.org/GNOME/dia 
 for more information on the dia mailing list and many other
 dia-related things.
 
---
-
 If you need to alter the list of contributors, documentors,
 etc., the authoritative list is in app/authors.h.
 
 
-Some comments about the source:
--------------------------------
-
- Everything on the screen 'inherits' from the structure Object
+# Some comments about the source
+Everything on the screen 'inherits' from the structure Object
 in lib/object.h. (ps. this is a nice place to start reading the code.).
 Inherits in C means (as in gtk) that it begins with a copy of that structure.
 Some base classes exists in lib/, like element.h (for doing 'box-like'
@@ -29,7 +26,7 @@ connections with orthogonal lines, like the uml-stuff) and render_object.h
 the different object in the object-libraries like objects/standard object/UML
 and object/network.
 
- The objects work by filling out two structures that the main program (app/*)
+The objects work by filling out two structures that the main program (app/*)
 uses to handle the objects. The ObjectType structure which consists of some
 info and a pointer to the type-operations (create+load+save). There's one
 ObjectType per object type currently loaded. Then the Object structure, there
@@ -45,14 +42,11 @@ be copy-pasted from an object like the one you're doing. Rendering to
 screen/postscript is done through a 'Renderer' abstraction that can be found
 in lib/render.h.
 
-XML based objects:
-------------------
+## XML based objects
 You can (from version 0.80) create new objects using a SVG like XML languange.
 The file doc/custom-shapes has more information about this.
 
-Note on handles and connection points:
---------------------------------------
-
+## Note on handles and connection points:
 An object has handles to resize it. A handle can be moved either because
 the user dragged it with the mouse, or the handle is attached to another
 object, which moved itself. The handles are diplayed as little squares
@@ -74,17 +68,18 @@ the connectionpoint is saved as the index of the connectionpoint. So make
 sure the order of the connectionpoints is the same when loading the saved
 object.
 
-Notes on static analysis
-------------------------
-Some of the recent changes (log message starting with [scan-build] are suggested
-by static source analysis, see http://clang-analyzer.llvm.org/scan-build
+# Notes on static analysis
+Some of the recent changes (log message starting with `scan-build` are suggested
+by static source analysis, see http://clang-analyzer.llvm.org/scan-build )
+
 To use it just run ./configure and make through the scan-build script, like:
 
-PATH=/mnt/Home/from-svn/llvm/Release/bin:$PATH 
/mnt/Home/from-svn/llvm/tools/clang/tools/scan-build/scan-build ./configure --prefix=/opt --enable-debug=yes
-  and
-PATH=/mnt/Home/from-svn/llvm/Release/bin:$PATH 
/mnt/Home/from-svn/llvm/tools/clang/tools/scan-build/scan-build -v -v make -j3
-  view with
-PATH=/mnt/Home/from-svn/llvm/Release/bin:$PATH /mnt/Home/from-svn/llvm/tools/clang/tools/scan-view/scan-view
+```
+export PATH=/mnt/Home/from-svn/llvm/Release/bin:$PATH
+/mnt/Home/from-svn/llvm/tools/clang/tools/scan-build/scan-build ./configure --prefix=/opt --enable-debug=yes
+/mnt/Home/from-svn/llvm/tools/clang/tools/scan-build/scan-build -v -v make -j3
+/mnt/Home/from-svn/llvm/tools/clang/tools/scan-view/scan-view
+```
 
 (given an uninstalled checkout of llvm to /mnt/Home/from-svn/llvm)
 
diff --git a/README.md b/README.md
index 1e6ff2b5..f8cf6a19 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,11 @@ Dia is a GNU program, and is Free Software.  See the COPYING file for the licenc
 
 The official homepage for Dia is at: https://gitlab.gnome.org/GNOME/dia
 
-General documentation can be found in the doc/ directory.
+General documentation can be found in the [doc/](doc/) directory.
 
-If you are thinking of contributing (either code or diagrams), please see (HACKING)[HACKING].
+If you are thinking of contributing (either code or diagrams), please see [HACKING](HACKING.md).
 
-For compilation and installation instructions please see (INSTALL)[INSTALL].
+For compilation and installation instructions please see [INSTALL](INSTALL).
 
 # Bug reporting
 
@@ -30,15 +30,15 @@ Please feel free to send us comments/feedback/questions on our mailing list:
 https://mail.gnome.org/mailman/listinfo/dia-list
 
 If you don't want to send a full email or just want to say "Hi!", we also hang out on IRC on GimpNet
-(irc.gimp.org)[irc.gimp.org] on `#dia-editor` channel.  Dia has been inactive for a few years now so
+[irc.gimp.org](irc.gimp.org) on `#dia-editor` channel.  Dia has been inactive for a few years now so
 it is very nice when we hear from people using it.
 
-# We're "hiring"
+# Help Wanted
 
 There is a lot of work to be done in order to bring Dia up to date.  Part of the reason why Dia has
 been around for so long is that it is very stable.  We intend to keep it that way.
 
-## General contributions
+### General contributions
 
 We would love to have more people on-board helping improving Dia.  For that, the only requirement is
 patience :slight_smile:
@@ -49,24 +49,24 @@ Do not be offended: we aren't trying to be mean, control-freaks or in any way be
 it's simply that good things take time and there's no way to rush quality.
 With that in mind, we welcome all contributions, no matter how tiny so please get in touch.
 
-## Windows build maintainer
+### Windows build maintainer
 
 We currently need somebody to look after the Windows builds and packages.  Most of us use Linux as
 our main operating system, so if you use Windows and would like to program on Dia on Windows, for
 example, getting it running on Visual Studio + Meson, please get in touch.  Note that this involves
 doing full development on Windows and is not limited to just getting it to compile.
 
-## MacOS build maintainer
+### MacOS build maintainer
 
 Similarly to the above, we need somebody to ensure Dia builds and runs well on macOS.
 
-## Documentation writers & translators (German, French, Basque, Polish etc)
+### Documentation writers & translators (German, French, Basque, Polish etc)
 
 Much of the documentation in doc/ is outdated.  We need somebody to go through the documents, check
 what is good, update them and then maintain them.  If you enjoy or want to practice technical writing
 or would be interested in helping with the translation we would love to hear from you!
 
-## Testers
+### Testers
 
 One simple way to ensure Dia works well for everybody is to test it on as many machines as possible.
 This role is simple and is a very good way to get more familiar with the Dia codebase.  Plus, the more
@@ -74,14 +74,14 @@ people Dia works for from source, the easier it is for package maintainers and t
 anybody to contribute patches:
 
 1. Obtain a machine (ARM, ARM64, x86_64, SPARC, doesn't matter) in one or more of the following ways:
-  1. Local laptop, desktop, etc
-  2. Premade box from https://www.osboxes.org/ or similar
-  3. Instal a virtual machine from ISO
+   - Local laptop, desktop, etc
+   - Premade box from https://www.osboxes.org/ or similar
+   - Instal a virtual machine from ISO
 2. Follow the compilation & installation instructions for Dia
 3. See if you can get all the features of Dia running.
-  1. Try various meson options: https://mesonbuild.com/Configuring-a-build-directory.html
-  2. Try to install dependencies in a different order.
-  3. Try a different compiler
+   - Try various meson options: https://mesonbuild.com/Configuring-a-build-directory.html
+   - Try to install dependencies in a different order.
+   - Try a different compiler  
 4. If anything is off and hasn't been reported before, let us know!  If it has been reported,
 give the issue a "+1".
 5. If you've tried your best and haven't found anything wrong, also give us a shout :-)