Add doc

.gitignore

@@ -1,4 +1,5 @@
 /docs/
+_build
 /lib/
 /bin/
 /.shards/

Makefile

@@ -4,24 +4,24 @@ SOURCES=$(shell find -name '*.cr')
 LDFLAGS=
 DESTDIR=/usr
 
-BUILDDIR=_build
+BUILD_DIR=_build
 
 all: build
 
 $(BUILD_DIR):
 	mkdir -p $(BUILD_DIR)
 
-$(BUILDDIR)/kathmandu_time: $(BUILDDIR) $(SOURCES)
-	crystal build $(LDFLAGS) src/kathmandu_time.cr -o $(BUILDDIR)/kathmandu_time
+$(BUILD_DIR)/kathmandu_time: $(BUILD_DIR) $(SOURCES)
+	crystal build $(LDFLAGS) src/kathmandu_time.cr -o $(BUILD_DIR)/kathmandu_time
 
-build: $(BUILDDIR)/kathmandu_time
+build: $(BUILD_DIR)/kathmandu_time
 
 build-release: LDFLAGS=--release --no-debug
 build-release: build
 
 install: build
 	install -m 0755 -o root -g root \
-		$(BUILDDIR)/kathmandu_time \
+		$(BUILD_DIR)/kathmandu_time \
 		$(DESTDIR)/bin/kathmandu_time
 
 spec:
@@ -33,5 +33,5 @@ run:
 	crystal run src/kathmandu_time.cr
 
 clean:
-	rm -f $(BUILDDIR)/kathmandu_time
+	rm -f $(BUILD_DIR)/kathmandu_time
 

README.md

@@ -4,24 +4,22 @@ TODO: Write a description here
 
 ## Installation
 
-TODO: Write installation instructions here
+Make sure you have Crystal and Make installed on your system.
+
+Then type
+
+```shell-session
+$ make build
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+```shell-session
+$ ./_build/kathmandu_time 21:30
+Paris:     21:30 +02:00
+Kathmandu: 01:11 +05:41
+```
 
-## Development
-
-TODO: Write development instructions here
-
-## Contributing
-
-1. Fork it (<https://github.com/glenux/./fork>)
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
-
-## Contributors
+## Authors
 
 - [Glenn Y. Rolland](https://github.com/glenux) - creator and maintainer