From 5a246159f86a8a9418564947e68221cc7c2da370 Mon Sep 17 00:00:00 2001 From: "Blake J. Harnden" Date: Thu, 11 Jan 2018 11:29:06 -0800 Subject: [PATCH] updates to readme to leverage code blocks markdown --- README.rst | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/README.rst b/README.rst index 1e85692f..75b6795a 100644 --- a/README.rst +++ b/README.rst @@ -33,10 +33,12 @@ Building CORE To build this software you should use: - ./bootstrap.sh - ./configure - make - sudo make install +```bash +./bootstrap.sh +./configure +make +sudo make install +``` Note: You may need to pass the proxy settings to sudo make install: sudo make install HTTP_PROXY= @@ -62,9 +64,11 @@ Being able to build documentation depends on help2man being installed. Once that has been done you can run the following commands: - ./bootstrap.sh - ./configure - make html +```bash +./bootstrap.sh +./configure +make html +``` Building Packages ================= @@ -75,11 +79,13 @@ Install fpm Build package commands, DESTDIR is used for gui packaging only -* ./bootstrap.sh -* ./configure -* make -* mkdir /tmp/core-gui -* make fpm DESTDIR=/tmp/core-gui +```bash +./bootstrap.sh +./configure +make +mkdir /tmp/core-gui +make fpm DESTDIR=/tmp/core-gui +``` This will produce: @@ -92,12 +98,16 @@ Running CORE First start the CORE services: - sudo /etc/init.d/core-daemon start +```bash +sudo /etc/init.d/core-daemon start +``` This automatically runs the core-daemon program. Assuming the GUI is in your PATH, run the CORE GUI by typing the following: - core-gui +```bash +core-gui +``` This launches the CORE GUI. You do not need to run the GUI as root.