Update README.md
authorRyan Reyes <50762130+TechProofreader@users.noreply.github.com>
Tue, 4 Jun 2024 01:30:54 +0000 (21:30 -0400)
committerGleb Balykov/Advanced System SW Lab /SRR/Staff Engineer/Samsung Electronics <g.balykov@samsung.com>
Sun, 7 Jul 2024 12:43:12 +0000 (15:43 +0300)
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.

docs/guide/README.md

index de5911c37e3325ee16fe98e5133231c0d7b655a4..5e3a701028142aa1f3a8f5291a0edb02b8006131 100644 (file)
@@ -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.
+