Mercurial > hg > cline / changeset

--- a/README	Fri Dec 28 17:00:38 2012 +0100
+++ b/README	Fri Dec 28 17:15:23 2012 +0100
@@ -3,9 +3,11 @@
                              Copyright (C) 2013 Mike Becker
 
 Contents:
-1) About ................................................................... 11
-2) Contact Information ..................................................... 23
-3) License ................................................................. 29
+1) About ................................................................... 13
+2) Build instructions ...................................................... 25
+3) Usage example ........................................................... 41
+4) Contact Information ..................................................... 50
+5) License ................................................................. 56
 
 
 1) About ______________________________________________________________________
@@ -20,13 +22,38 @@
 
 Type cline --help for further information.
 
-2) Contact Information ________________________________________________________
+2) Build instructions _________________________________________________________
+
+To build cline with gcc navigate to the root directory of the project and type:
+  make
+
+To rebuild cline type:
+  make clean all
+
+To install cline type (as root):
+  make install
+
+If you build cline with mingw under Windows, you need to type:
+  make CONF=mingw
+or
+  make CONF=mingw clean all
+
+3) Example usage ______________________________________________________________
+
+You can test cline right away with the cline project files. Just type:
+  cline -rms .c,.h --exclude-cstyle-comments
+
+This will find any .c or .h file recursively in the cline project folder and
+won't display other files (-m option). It will also skip comments when counting
+lines.
+
+4) Contact Information ________________________________________________________
 
 You can contact us by either one of the following mail addresses:
   universe@uap-core.de   -   Direct developer contact
   info@uap-core.de       -   Generic mail address
 
-3) License ____________________________________________________________________
+5) License ____________________________________________________________________
 
 Copyright 2013 Mike Becker. All rights reserved.
 
@@ -50,4 +77,4 @@
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
-
+ 
\ No newline at end of file