From: Ryan Reyes <50762130+TechProofreader@users.noreply.github.com>
Date: Tue, 4 Jun 2024 01:30:54 +0000 (-0400)
Subject: Update README.md
X-Git-Tag: accepted/tizen/unified/x/20240829.020324~6
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=309c9db358d26bccd8664410b17f3d23d2bfe7ef;p=sdk%2Ftools%2Fnetcoredbg.git

Update README.md

Updated the header title, updated some grammar, added missing hyperlinks, formatted the shell commands into a single code block since the code formatting was missing, and revised some of the language to be more readable.
---

diff --git a/docs/guide/README.md b/docs/guide/README.md
index de5911c..5e3a701 100644
--- a/docs/guide/README.md
+++ b/docs/guide/README.md
@@ -1,28 +1,32 @@
-# NetcoreDBG Developer's Guide.
-
-An easy guide to NetcoreDBG C# debugger.
+# The NetCoreDbg Developer's Guide.
 
+This is an easy user guide to the NetCoreDbg C# debugger.
 
 ## Downloads:
 
-Binary releases are available right here on github:
-https://github.com/Samsung/netcoredbg/releases
-
+Binary releases are available here on [Github](https://github.com/Samsung/netcoredbg/releases).
 
 ## Compiling:
 
-On Linux, Install `dia`, `rsvg-convert`, and most of LaTeX, then run `make`.
+On Linux, Install `dia`, `rsvg-convert`, and most of [LaTeX](https://www.latex-project.org/get/), then run `make`.
+
+The following shell commands are a good start:
 
+```
 $ sudo apt update
 $ sudo apt install dia
 $ sudo apt install texlive-latex-base texlive-fonts-recommended texlive-fonts-extra texlive-latex-extra
 $ sudo apt install texlive-binaries
 $ sudo apt install librsvg2-bin
+```
 
-This automates generation of includable diagrams from the respective .dia files.
-If you manage to automate the process on any other OS, please share!
+This automates the generation of available diagrams from the respective .dia files.
 
+*Note: If you manage to automate the process on any other OS, please share it here on Github so that our team can review it!*
 
 ## Reporting issues:
 
-Please report issues with this guide here on github. Pull requests are also welcome.
+Please report issues with this guide here on Github.
+
+Pull requests are also welcome.
+