Quite a few improvements

- Improve project structure
- Update LICENSE date
- Add --render command
- Add MAN page
- Add automatic versioning

Author: Leandros

src/.astylerc renamed to .astylerc

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 Arvid Gerstmann
+Copyright (c) 2016 Arvid Gerstmann
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

LICENSE

@@ -0,0 +1,128 @@
+# General
+CC			= clang
+LD			= clang
+RM			= rm -rf
+RMDIR		= rmdir
+INSTALL		= install
+DEBUG		= -ggdb -O0 -march=native -ftrapv
+
+## CHANGE THIS ##
+TARGET		= tldr
+SRCDIR		= src
+OBJDIR		= obj
+BINDIR		= .
+MANDIR		= man
+## CHANGE THIS ##
+
+# CFLAGS, LDFLAGS, CPPFLAGS, PREFIX can be overriden on CLI
+CFLAGS		:= $(DEBUG)
+CPPFLAGS	:=
+LDFLAGS		:=
+PREFIX		:= /usr/local
+TARGET_ARCH :=
+
+
+# Compiler Flags
+ALL_CFLAGS		:= $(CFLAGS)
+ALL_CFLAGS		+= -Wall -Wextra -pedantic -ansi
+ALL_CFLAGS		+= -fno-strict-aliasing
+ALL_CFLAGS		+= -Wuninitialized -Winit-self -Wfloat-equal
+ALL_CFLAGS		+= -Wundef -Wshadow -Wc++-compat -Wcast-qual -Wcast-align
+ALL_CFLAGS		+= -Wconversion -Wsign-conversion -Wjump-misses-init
+ALL_CFLAGS		+= -Wno-multichar -Wpacked -Wstrict-overflow -Wvla
+ALL_CFLAGS		+= -Wformat -Wno-format-zero-length -Wstrict-prototypes
+ALL_CFLAGS		+= -Wno-unknown-warning-option
+
+# Version Generation
+VER				:= $(shell git describe --tags --always --dirty)
+
+# Preprocessor Flags
+ALL_CPPFLAGS	:= $(CPPFLAGS) -DVERSION='"$(VER)"'
+ALL_CPPFLAGS	+= $(shell pkg-config --cflags libzip)
+ALL_CPPFLAGS	+= -I/usr/include
+ALL_CPPFLAGS	+= -I/usr/local/include
+ALL_CPPFLAGS	+= -I/usr/local/opt/curl/include
+ALL_CPPFLAGS	+= -I/usr/local/opt/libzip/include
+
+# Linker Flags
+ALL_LDFLAGS		:= $(LDFLAGS) -L/usr/lib
+ALL_LDFLAGS		+= -L/usr/local/lib
+ALL_LDFLAGS		+= -L/usr/local/opt/curl/lib
+ALL_LDFLAGS		+= -L/usr/local/opt/libzip/lib
+ALL_LDLIBS		:= -lc -lm -lcurl -lzip
+
+
+# Source, Binaries, Dependencies
+SRC			:= $(shell find $(SRCDIR) -type f -name '*.c')
+OBJ			:= $(patsubst $(SRCDIR)/%,$(OBJDIR)/%,$(SRC:.c=.o))
+DEP			:= $(OBJ:.o=.d)
+BIN			:= $(BINDIR)/$(TARGET)
+-include $(DEP)
+
+# Man Pages
+MANSRC		:= $(shell find $(MANDIR) -type f -name '*.1')
+MANPATH		:= $(PREFIX)/share/man/man1
+
+
+# Verbosity Control, ala automake
+V 			= 0
+
+# Verbosity for CC
+REAL_CC 	:= $(CC)
+CC_0 		= @echo "CC $<"; $(REAL_CC)
+CC_1 		= $(REAL_CC)
+CC 			= $(CC_$(V))
+
+# Verbosity for LD
+REAL_LD 	:= $(LD)
+LD_0 		= @echo "LD $@"; $(REAL_LD)
+LD_1 		= $(REAL_LD)
+LD 			= $(LD_$(V))
+
+# Verbosity for RM
+REAL_RM 	:= $(RM)
+RM_0 		= @echo "Cleaning..."; $(REAL_RM)
+RM_1 		= $(REAL_RM)
+RM 			= $(RM_$(V))
+
+# Verbosity for RMDIR
+REAL_RMDIR 	:= $(RMDIR)
+RMDIR_0 	= @$(REAL_RMDIR)
+RMDIR_1 	= $(REAL_RMDIR)
+RMDIR 		= $(RMDIR_$(V))
+
+
+
+# Build Rules
+.PHONY: clean format
+.DEFAULT_GOAL := all
+
+all: setup $(BIN)
+setup: dir
+remake: clean all
+
+dir:
+	@mkdir -p $(OBJDIR)
+	@mkdir -p $(BINDIR)
+
+
+$(BIN): $(OBJ)
+	$(LD) $(ALL_LDFLAGS) $^ $(ALL_LDLIBS) -o $@
+
+$(OBJDIR)/%.o: $(SRCDIR)/%.c
+	$(CC) $(ALL_CFLAGS) $(ALL_CPPFLAGS) -c -MMD -MP -o $@ $<
+
+
+install: $(BIN) $(MANSRC)
+	$(INSTALL) -d $(PREFIX)/bin
+	$(INSTALL) $(BIN) $(PREFIX)/bin
+	$(INSTALL) -d $(MANPATH)
+	$(INSTALL) $(MANSRC) $(MANPATH)
+
+clean:
+	$(RM) $(OBJ) $(DEP) $(BIN)
+	$(RMDIR) $(OBJDIR) $(BINDIR) 2> /dev/null; true
+
+format:
+	astyle --options=.astylerc $(SRCDIR)/*.c
+

Makefile

@@ -24,7 +24,7 @@ To build the latest version from source:
 if [[ "`uname`" == "Darwin"  ]]; then brew install curl libzip pkg-config; fi
 if [[ "`uname`" == "Linux" ]]; then apt-get install libcurl4-openssl-dev libzip-dev pkg-config; fi
 git clone https://github.com/tldr-pages/tldr-cpp-client.git tldr-c-client
-cd tldr-c-client/src
+cd tldr-c-client
 make
 make install
 ```
@@ -45,25 +45,27 @@ Building the `tldr` client is pretty straightforward.
 
 #### Compiling
 
-The [`Makefile`](https://github.com/tldr-pages/tldr-cpp-client/blob/master/src/Makefile) in the `src` directory has all you need
-for builing the project.
+The [`Makefile`](https://github.com/tldr-pages/tldr-cpp-client/blob/master/Makefile)
+in the root directory has all you need for builing the project.
+
+Just call `make` and `tldr` will build itself.
 
 ```
-cd src
 make
 ```
 
 ## Usage
 
 ```
-usage: tldr [-v] [<command>] <search>
+usage: ./tldr [-v] [OPTION]... SEARCH
 
 available commands:
     -v                   print verbose output
     --version            print version and exit
     -h, --help           print this help and exit
     -u, --update         update local database
     -c, --clear-cache    clear local database
-    -p, --platform=<platform> select platform, supported are linux / osx / common
+    -p, --platform=PLATFORM select platform, supported are linux / osx / sunos / common
+    -r, --render=PATH    render a local page for testing purposes
 ```
 

README.md

@@ -0,0 +1,48 @@
+.\" Manpage for tldr.
+.\" Contact [email protected] to correct errors or typos.
+.mso www.tmac
+.TH TLDR 1
+.SH NAME
+tldr \- A collection of simplified and community-driven man pages.
+.SH SYNOPSIS
+.B tldr
+[\fB\-v\fR]
+[\fIOPTION\fR]... \fISEARCH\fR
+.SH DESCRIPTION
+tldr is a collection of simplified and community-driven man pages, for commonly
+used commandline tools.
+.SH OPTIONS
+.TP
+.BR \-v
+verbose output
+.TP
+.BR \-\-version
+output version information and exit
+.TP
+.BR \-h ", " \-\-help
+display help and exit
+.TP
+.BR \-u ", " \-\-update
+update local database and exit
+.TP
+.BR \-c ", " \-\-clear-cache
+remove local database and exit
+.TP
+.BR \-p ", " \-\-platform=\fIPLATFORM\fR
+select platform, supported are \fIlinux\fR / \fIosx\fR / \fIsunos\fR / \fIcommon\fR
+.TP
+.BR \-r ", " \-\-render=\fIPATH\fR
+render a local page for testing purposes
+.SH EXIT STATUS
+0 on success, any other positive value otherwise
+.SH SEE ALSO
+The source is available at:
+.URL "https://github.com/tldr-pages/tldr-cpp-client" "" ""
+.SH REPORTING BUGS
+Report bugs through the Github repository:
+.URL "https://github.com/tldr-pages/tldr-cpp-client" "" "."
+.SH COPYRIGHT
+The MIT License (MIT)
+
+Copyright (c) 2016 Arvid Gerstmann.
+