improved readme

Author: thEpisode

README.md

@@ -1,24 +1,41 @@
-# ASM
+# Linux Shellcode Generator
 
-This is a series of experiments in ASM to execute shellcodes with C, I prefer Intel syntax but if you found any code in AT&T code don't worry, only read documentation inside source code
+This is a shellcode generator in ASM to fastdevelopment and test it in a C template, I prefer Intel syntax but if you found any AT&T syntaxis in experiments code don't worry, only read documentation inside source code
 
-All source codes run on Linux, I will try to test in some many distros
+All source codes run on Debian, I will try to test in some many distros.
 
-## x86 support
+## Table of contents
+- [Manual compilation and test](#manual-compilation-and-test)
+    * [x86 support](#x86-support)
+		* [Compiling .asm source codes](#compiling-.asm-source-codes)
+		* [Dissasembly compiled to read hexadecimal code](#dissasembly-compiled-to-read-hexadecimal-code)
+		* [Compiling .c source codes](#compiling-.c-source-codes)
+- [Binary to Shellcode string tool](#binary-to-shellcode-string-tool)
+	* [shellcode.sh Usage](#shellcode.sh-usage)
+- [ASM Fast Development Projects](#asm-fast-development-projects)
+	* [ASM Fast Development Usage](#asm-fast-development-usage)
+	* [Creating new ASM Fast Development Projects](#creating-new-asm-fast-development-projects)
+	* [Compiling ASM Fast Development Projects](#compiling-asm-fast-development-projects)
+
+## Manual compilation and test
+
+If you want to compile and create a trace of all your code use the traditional steps. I know this is hard to remember, use the next snippets.
+
+### x86 support
 
 **Disclaimer:** This section is under x86 support, all code above is **only** for x86 architectures. In next versions support x64 and x84_64.
 
-### Compiling .asm source codes
+#### Compiling .asm source codes
 
 > nasm -f elf sourceCode.asm
 
 > ld -o executableName sourceCode.o
 
-### Dissasembly to read hexadecimal code
+#### Dissasembly compiled to read hexadecimal code
 
 > objdump -d executableName
 
-### Compiling .c source codes
+#### Compiling .c source codes
 
 Normal purposes
 
@@ -28,13 +45,13 @@ Testing shellcodes
 
 > gcc cExecutableName.c -o cExecutableName -fno-stack-protector -z execstack -no-pie
 
-## Binary to Shellcode string
+## Binary to Shellcode string tool
 
-To easy extracting shellcodes use following script to generate shellcode strings and tests
+To easy extracting shellcodes use shellcode.sh script contained in root project folder to generate shellcode strings and test it. You can extract a shellcode and print in console, save in a text file, inject into test project, build to check errors and run injected shellcode. Documentation is exposed below.
 
-### Usage
+### shellcode.sh Usage:
 
-    Usage: bash shellcode.sh [<options>] [<asm_filename>]
+    > bash shellcode.sh [<options>] [<asm_filename>]
 
         -e, --extract             Extract shellcode from binary and print
         -s, --save                Save shellcode into a .txt file
@@ -45,13 +62,15 @@ To easy extracting shellcodes use following script to generate shellcode strings
     Example:
       > bash shellcode.sh -tbr ~/ASM/HelloWorld/Helloworld.asm
 
-## ASM Fast Development Projects (x86)
+## ASM Fast Development Projects
 
-For fast development in asm, you could use following tool:
+I know that start a new project and contain all generated files is hard, for that reason I developed another tool for fast development in asm, you could create new projects with folder structure and using the [shellcode script](#binary-to-shellcode-string-tool) to compile and test use following tool:
+
+**Disclaimer:** This section is under x86 support, all code above is **only** for x86 architectures. In next versions support x64 and x84_64.
 
-### Usage
+### ASM Fast Development Usage
 
-    Usage: bash ASMFastDevelopment.sh [<options>] [<folder name>]
+    > bash ASMFastDevelopment.sh [<options>] [<folder name>]
 
         -h, --help                Show helps'
         -n, --new                 Create new project with folder name given
@@ -62,7 +81,7 @@ For fast development in asm, you could use following tool:
       > bash ASMFastDevelopment.sh -c HelloWorld
 
 
-### Creating new ASM Fast Development Projects (x86)
+### Creating new ASM Fast Development Projects
 
 > bash ASMFastDevelopment.sh --new HelloWorld
 
@@ -74,7 +93,7 @@ It generates:
         |- HelloWorld/
             |- HelloWorld.asm
 
-**Disclaimer**: Do not change the .asm file name!. If you need change it, **you need to change folder name**
+**Warning**: Do not change the .asm file name!. If you need change it, **you need to change folder name**
 
 ### Compiling ASM Fast Development Projects
 
@@ -88,6 +107,6 @@ It generates:
             |- HelloWorld.o
             |- HelloWorld [Executable file]
 
-## Remember
+## Small help
 
-![Registers](http://i.imgur.com/ZPYfZty.png)
+<div style="width:25%">![Registers](http://i.imgur.com/ZPYfZty.png)</div>