Narcissus/nwipe
2
0
Fork 0
mirror of https://github.com/martijnvanbrummelen/nwipe.git synced 2026-02-20 13:42:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #92 from PartialVolume/update_readme_and_readme.md

Browse Source 
Update Readme with package requirements
This commit is contained in:
Martijn van Brummelen
2018-11-28 08:43:39 +01:00
committed by GitHub
parent 00469644d8 cd16c2e86b
commit 545491940e
2 changed files with 52 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

55
README
View File

@@ -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

2
README.md
View File

@@ -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)