From a610c7fb7f47a1936ee011e511e81cd967aff533 Mon Sep 17 00:00:00 2001 From: Brian Barto Date: Mon, 16 May 2016 13:02:07 -0400 Subject: [PATCH] Separating out installation instructions to a different file. new file: INSTALL.md modified: README.md --- INSTALL.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 23 +-------------- 2 files changed, 87 insertions(+), 22 deletions(-) create mode 100644 INSTALL.md diff --git a/INSTALL.md b/INSTALL.md new file mode 100644 index 0000000..eee1242 --- /dev/null +++ b/INSTALL.md @@ -0,0 +1,86 @@ +Installation +------------ + +Below are installation instructions for various operating systems. Use the set of instructions that +best applies to you. If your operating system is missing from the list, see 'Generic Instructions' +at the bottom for help. + +If you can supply instructions for an operating system that is not listed here, please email me or +sibmit a pull request updating this document. + +#### Ubuntu/Debian/Mint Linux + +``` +sudo apt-get update +sudo apt-get install lib32ncurses5-dev lib32ncursesw5-dev +git clone https://github.com/bartobri/no-more-secrets.git +cd ./no-more-secrets +make +sudo make install +``` + +#### Fedora Linux + +``` +sudo dnf update --refresh +sudo dnf install ncurses-devel +git clone https://github.com/bartobri/no-more-secrets.git +cd ./no-more-secrets +make +sudo make install +``` + +#### Redhat/Cent OS Linux + +``` +sudo yum update +sudo yum install ncurses-devel +git clone https://github.com/bartobri/no-more-secrets.git +cd ./no-more-secrets +make +sudo make install +``` + +#### Arch Linux + +``` +sudo pacman -Sy +sudo pacman -S ncurses +git clone https://github.com/bartobri/no-more-secrets.git +cd ./no-more-secrets +make +sudo make install +``` + +#### Mac OSX + +Install the Homebrew package manager by following the instructiosn on the website: http://brew.sh/ + +Once Homebrew is installed, you can install no-more-secrets: + +brew install no-more-secrets + +#### Generic Instructions + +First, make sure you have the ncurses library installed: +``` +ls /usr/include | grep ncurses.h +``` +If the ncurses.h header file is not present, you may need to install the library. For example, on +Ubuntu you would type: +``` +sudo apt-get update +sudo apt-get install lib32ncurses5-dev lib32ncursesw5-dev +``` +For other flavors of Linux/Unix, use your package manager to search for the "ncurses" package. Install +it. If you see two different packages for "ncurses" and "ncursesw", install them both (as shown above +in the Ubuntu example). + +Next, download and build the standalone executable: +``` +git clone https://github.com/bartobri/no-more-secrets.git +cd ./no-more-secrets +make +sudo make install +``` + diff --git a/README.md b/README.md index c54c07c..7bac1bc 100644 --- a/README.md +++ b/README.md @@ -28,29 +28,8 @@ Two tools are provided for you to recreate this effect: Installing the Standalone Executable ------------------------------------ -First, make sure you have the ncurses library installed: -``` -ls /usr/include | grep ncurses.h -``` -If the ncurses.h header file is not present, you may need to install the library. On Ubuntu, type: -``` -sudo apt-get update -sudo apt-get install lib32ncurses5-dev lib32ncursesw5-dev -``` -If you are using a different flavor of linux, search your available packages for "ncurses" and install -it. If you see two different packages for "ncurses" and "ncursesw", install them both (as shown above -in the Ubuntu example). -Next, download and build the standalone executable: -``` -git clone https://github.com/bartobri/no-more-secrets.git -cd ./no-more-secrets -make -sudo make install -``` - -This will create and install an executable file `nms`. (Note that this also installs another -executable file named `sneakers` which is shown above.) +See the [INSTALL](INSTALL.md) file for a list of instructions for various operating systems. Using the Standalone Executable -------------------------------