From cd16c2e86b1f8c81f533f9fe12042598c7919ee9 Mon Sep 17 00:00:00 2001
From: Nick Law <nick.craig.law@gmail.com>
Date: Tue, 27 Nov 2018 21:56:14 +0000
Subject: [PATCH] Update Readme with package requirements

---
 README    | 55 +++++++++++++++++++++++++++++++++++++++++++++++++++----
 README.md |  2 +-
 2 files changed, 52 insertions(+), 5 deletions(-)

diff --git a/README b/README
index f414e5f..49cc7a9 100644
--- a/README
+++ b/README
@@ -1,13 +1,60 @@
-Installation
-============
-First bootstrap the source tree:
+Compiling & Installing
+======================
+
+Nwipe requires the following libraries to be installed.
+
+ncurses
+pthreads
+parted
+
+Debian & Ubuntu prerequisite
+============================
+
+If you compiling nwipe from source the following will need to be installed first
+
+sudo apt install build-essential
+sudo apt install pkg-config
+sudo apt install automake
+sudo apt install libncurses5-dev
+sudo apt install autotools-dev
+sudo apt install libparted-dev
+
+Compilation
+===========
+
+then create all the autoconf files:
+
 ./init.sh
 
-The install using the standard:
+Then compile & install using the standard: (Devs see below)
+
 ./configure
 make
 make install
 
+Developers !
+==========
+
+If you wish to submit pull requests to this code we would prefer you enable all warnings,
+this can be done using the alternate compile commands
+
+./configure --prefix=/usr CFLAGS='-O0 -g -Wall -Wextra'
+make
+make install
+
+The '-O0 -g' flags disable optimisations, this is required if your debugging with
+gdb in an IDE such as Kdevelop. Without these optimisations disabled you won't be
+able to see the values of many variables in nwipe, not to mention the IDE won't step
+through the code properly.
+
+The -Wall & -Wextra flags enable all compiler warnings. Please submit code with zero warnings.
+
+Once done with your coding then the released/patch/fixed code can be compiled with
+
+./configure --prefix=/usr && make && make install
+
+complete with all it's optimisations.
+
 The ncurses, pthreads and parted libraries are required for compiling.
 For any problems, please use the Github page:
 https://github.com/martijnvanbrummelen/nwipe
diff --git a/README.md b/README.md
index 86ba2c5..64d9e3a 100644
--- a/README.md
+++ b/README.md
@@ -11,5 +11,5 @@ To use from the git repository, first create all the autoconf files with
 
 Then do the standard ./configure --prefix=/usr && make && make install
 
-For release notes please see the [README file](README)
+For developer & release notes please see the [README file](README)