documentation: improve the readme file

Author: guyush1

README.md

@@ -1,8 +1,10 @@
 # Repository of static gdb and gdbserver
 
-The statically compiled gdb / gdbserver binaries are avaliable to download under github releases! 
+## **The statically compiled gdb / gdbserver binaries are avaliable to download under github releases!**
 
-# Compiling gdb using docker
+link: [gdb-static github releases](https://github.com/guyush1/gdb-static/releases)
+
+## Compiling gdb using docker
 
 This repository contains a dockerfile and build scripts to compile gdb and gdbserver statically for multiple architectures.
 Currently, the supported architectures are:
@@ -14,7 +16,7 @@ You can easily expand it to support more architectures by adding the appropriate
 
 NOTE: You don't need to interact with the dockerfile directly, as the Makefile will take care of everything for you.
 
-## Building for a specific architecture
+### Building for a specific architecture
 
 To build for a specific architecture, you can use the following command:
 ```bash
@@ -35,25 +37,25 @@ build/
             ...
 ```
 
-## Building for all architectures
+### Building for all architectures
 
 To build for all architectures, you can use the following command:
 ```bash
 make build
 ```
 
-## Cleaning the build
+### Cleaning the build
 
 To clean the build, you can use the following command:
 ```bash
 make clean
 ```
 
-# Notes about this file - read before proceeding!
+## Notes about this file - read before proceeding!
 
 While i already provided the gdb/gdbserver-15 statically compiled binaries handed out to you, some people might want to compile it to a different architecture, or compile a newer version of gdb in the future :). This rest of the file contains my compilation documentation so that you could save yourself some time and do it yourself, if you wish.
 
-## <VARAIBLES> in the script
+### <VARAIBLES> in the script
 
 When specifying the compilation dir throughout the compilation process (specified as <COMPILATION_DIR_PATH> in this file), DO NOT use relative pathing, or bash characters such as `~`. They will not get parsed correctly! Instead, use absolute paths only.
 
@@ -66,9 +68,9 @@ Examples to the <VARIABLES> throughout the script:
 Environment info:
 - glibc version: 2.39-0ubuntu8.3 (NOTE: When i compiled gdb-15 using an older glibc, such as the one i had in my ubuntu-20.04 machine, i received a segfault in gdb...).
 
-# Compiling gdb statically to the host platform
+## Compiling gdb statically to the host platform
 
-## 1) Compiling iconv
+### 1) Compiling iconv
 
 While compiling iconv is not a must, the libc-provided iconv (a utility to convert between encodings) may fail on different architectures,
 at least in my experiance. Thus, I recommended using a custom libiconv and compiling it into gdb.
@@ -85,7 +87,7 @@ V) run `cp -r ./include ./lib/.libs/`
 VI) run `mkdir ./lib/.libs/lib/`
 VII) run `cp ./lib/.libs/libiconv.a ./lib/.libs/lib/`
 
-## 2) Compiling gdb
+### 2) Compiling gdb
 
 Clone gdb from sourceware - https://sourceware.org/git/binutils-gdb.git.
 I checked out to the 15.1 tag.
@@ -99,16 +101,16 @@ IV) run `make all-gdb -j$(nproc)` - for gdbserver, run `make all-gdbserver -j$(n
 gdb will sit under gdb/gdb.
 gdbserver will sit under gdbserver/gdbserver.
 
-# Cross compiling gdb statically to other architectures.
+## Cross compiling gdb statically to other architectures.
 
 Cross compiling gdb statically is a bit more complicated then regular static compilation. In order to cross compile gdb statically, we will need to compile libgmp and libmpfr as well as iconv.
 
-## 1) Compiling iconv
+### 1) Compiling iconv
 
 Work according to the same process as described under the compilation to the host platform, aside from the configure script:
 IV) run `../configure --enable-static CC=<CROSS_COMPILER_C> CXX=<CROSS_COMPILER_CPP> --host=<HOST_NAME>`
 
-## 2) Compiling libgmp
+### 2) Compiling libgmp
 
 Download and extract the latest edition from https://gmplib.org/.
 I used the 6.3.0 edition.
@@ -122,7 +124,7 @@ V) run `cp gmp.h ./.libs/include/`
 VI) run `mkdir ./.libs/lib`
 VII) run `cp ./.libs/libgmp.a ./.libs/lib`
 
-## 3) Compiling libmpfr
+### 3) Compiling libmpfr
 
 Download and extract the latest edition from https://www.mpfr.org/.
 I used the 4.2.1 edition.
@@ -136,7 +138,7 @@ V) run `cp ./src/.libs/libmpfr.a ./src/.libs/lib`
 VI) run `mkdir ./src/.libs/include`
 VII) run `cp ../src/mpfr.h ./src/.libs/include/`
 
-## 4) Compiling gdb
+### 4) Compiling gdb
 
 Work according to the same process as described under the compilation to the host platform, aside from the configure script:
 III) run `../configure --enable-static --with-static-standard-libraries --disable-tui --disable-inprocess-agent --with-libiconv-prefix=<COMPILATION_DIR_PATH>/lib/.libs/ --with-libiconv-type=static --with-gmp=<COMPILATION_DIR_PATH>/.libs/ --with-mpfr=<COMPILATION_DIR_PATH>/src/.libs/ CC=<CROSS_COMPILER_C> CXX=<CROSS_COMPILER_CPP> --host=<HOST_NAME>`