Skip to content

Commit

Permalink
added make install and moved some docs around
Browse files Browse the repository at this point in the history
  • Loading branch information
k-anderson committed May 3, 2016
1 parent 8fc8d61 commit 664319c
Show file tree
Hide file tree
Showing 14 changed files with 56 additions and 184 deletions.
4 changes: 3 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ELVIS = $(ROOT)/utils/elvis/elvis

KAZOODIRS = core/Makefile applications/Makefile

.PHONY: $(KAZOODIRS) deps core apps xref xref_release dialyze dialyze-apps dialyze-core dialyze-kazoo clean clean-test clean-release build-release build-ci-release tar-release release read-release-cookie elvis
.PHONY: $(KAZOODIRS) deps core apps xref xref_release dialyze dialyze-apps dialyze-core dialyze-kazoo clean clean-test clean-release build-release build-ci-release tar-release release read-release-cookie elvis install

all: compile rel/dev-vm.args

Expand Down Expand Up @@ -95,6 +95,8 @@ endif
release:
@RELX_REPLACE_OS_VARS=true KZname='-name $(REL)' _rel/kazoo/bin/kazoo $(ACT) "$$@"

install: compile build-release
cp -a _rel/kazoo /opt

read-release-cookie: REL ?= kazoo_apps
read-release-cookie:
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
## Kazoo [![Build Status](https://travis-ci.org/2600hz/kazoo.svg?branch=master)](https://travis-ci.org/2600hz/kazoo) [![Issue Stats](http://issuestats.com/github/2600hz/kazoo/badge/pr)](http://issuestats.com/github/2600hz/kazoo) [![2600Hz IRC](https://img.shields.io/badge/irc-%232600hz-orange.svg)](https://webchat.freenode.net/?channels=2600hz)

**[Periodically check our announcements for important developer updates!](https://github.com/2600hz/kazoo/tree/master/doc/announcements.md)**

````
... ........                                                
......+OO=..                                                
Expand Down Expand Up @@ -120,7 +122,7 @@ No problem! We have many different places where folks can chip in time. These in

Translation efforts are always appreciated. We're working on redesigning how our back- and front-ends handle the world's languages and hope to make it easy to contribute translations. Stay tuned for more; please let us know of your interest and be sure to join the mailing lists so you can receive announcements regarding internationalization efforts.

If you have a non-US deployment, please consider sharing your system configuration! We are trying to build [examples]https://github.com/2600Hz/kazoo/tree/master/applications/crossbar/doc/internationalization) for every locality and fix any deficiencies.
If you have a non-US deployment, please consider sharing your system configuration! We are trying to build [examples]https://github.com/2600Hz/kazoo/tree/master/doc/internationalization) for every locality and fix any deficiencies.

### I know me some Erlang! How can I contribute?

Expand All @@ -137,7 +139,7 @@ If you have a non-US deployment, please consider sharing your system configurati

* Help us write some automated testing tools
* Check out our Javascript/HTML/CSS [GUI](https://github.com/2600Hz/monster-ui)
* Check out our REST APIs and help us create SDKs in your favorite languages ([PHP](https://github.com/2600Hz/kazoo-php-sdk) | [RUBY](https://github.com/2600Hz/kazoo-ruby-sdk))
* Check out our REST APIs and help us create SDKs in your favorite languages ([PHP](https://github.com/2600Hz/kazoo-php-sdk) | [PYTHON](https://github.com/2600hz/kazoo-python-sdk) | [RUBY](https://github.com/2600Hz/kazoo-ruby-sdk))
* Check out our Pivot APIs and help us create SDKs in your favorite languages
* Check out our AMQP APIs and create a WhApp in your favorite language
* Help out with the [configuration scripts](https://github.com/2600Hz/kazoo-configs)
Expand All @@ -151,4 +153,6 @@ See the [installation](./doc/installation.md) page to build.
* Join us at [KazooCon!](http://kazoocon.com/)
* Visit [the community site](http://2600hz.org)
* Bugs and feature requests can be found [here](http://tickets.2600hz.org)
* [![2600Hz IRC](https://img.shields.io/badge/irc-%232600Hz-orange.svg)](https://webchat.freenode.net/?channels=2600Hz)
* [![2600Hz IRC](https://img.shields.io/badge/irc-%232600Hz-orange.svg)](https://webchat.freenode.net/?channels=2600Hz)A
* [Users mailing list](https://groups.google.com/forum/?fromgroups#!forum/2600Hz-users)
* [Developers mailing list](https://groups.google.com/forum/?fromgroups#!forum/2600Hz-dev)
46 changes: 46 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Getting Started

## Welcome!

This page is a work-in-progress as well as our documentation. As you begin your journey with Kazoo please consider typing out what you learn and submitting it back for others. If you are unable to create markdown files or know proper `git` procedures don't worry, just contact us and we will work to incorporate your notes into the docs.

Getting started with Kazoo depends on what you are looking to do with it but almost always starts with [installation](installation.md)! Once you have your platform up and running check bellow for some highlighted documents based on your goals.

We recommend you keep the following resources handy and hope you enjoy your experience with Kazoo!

* Join us at [KazooCon!](http://kazoocon.com/)
* Visit [the community site](http://2600hz.org)
* Bugs and feature requests can be found [here](http://tickets.2600hz.org)
* [![2600Hz IRC](https://img.shields.io/badge/irc-%232600Hz-orange.svg)](https://webchat.freenode.net/?channels=2600Hz)
* Feel free to drop a line to the [dev mailing list](https://groups.google.com/forum/?fromgroups#!forum/2600Hz-dev) or the [users mailing list](https://groups.google.com/forum/?fromgroups#!forum/2600Hz-users)
* Read Github's [great introduction](https://help.github.com/articles/fork-a-repo/) to forking repos and [pull requests](https://help.github.com/articles/using-pull-requests/).
* Check out our Javascript/HTML/CSS [GUI](https://github.com/2600Hz/monster-ui)
* Check out some existing SDKs [PHP](https://github.com/2600Hz/kazoo-php-sdk) | [PYTHON](https://github.com/2600hz/kazoo-python-sdk) | [RUBY](https://github.com/2600Hz/kazoo-ruby-sdk)
* [Learn you some Erlang!](http://learnyousomeerlang.com/)
* Bookmark this awesome [Erlang reference/docs](http://erldocs.com/) site
* Check out the [FreeSWITCH documentation](https://freeswitch.org/confluence/display/FREESWITCH/FreeSWITCH+Explained)
* Take a look at the [Kamailio documentation](https://www.kamailio.org/w/documentation/)
* Learn all about [AMQP basics](https://www.rabbitmq.com/tutorials/amqp-concepts.html)
* Get introduced to [CouchDB/Bigcouch](http://guide.couchdb.org/draft/cookbook.html)

## Developer

* Code Standards (comming soon)
* [Number Manager Library](/core/kazoo_number_manager/doc)
* [AMQP Workers](/core/kazoo_amqp/doc/amqp_workers.md)

## Integrator

* [REST API](/applications/crossbar/doc)
* [Webhooks](/applications/webhooks/doc/maintenance.md)
* [Websockets](/applications/blackhole/doc/index.md)
* [Pivot](/applications/pivot/doc/index.md)

## Operator

* [eCallMgr Configuration](/applications/ecallmgr/doc/config.md)
* [eCallMgr Maintenance Commands](/ecallmgr/doc/maintenance.md)
* [Managing ACLs](/applications/ecallmgr/doc/acls.md)
* [Couch Compaction](/core/kazoo_couch/doc/compaction.md)
* [Internationalization Examples](/doc/internationalization/)
* [Stepswitch Formatters](/applications/stepswitch/doc/formatters.md)
File renamed without changes.
52 changes: 0 additions & 52 deletions doc/getting_started.md

This file was deleted.

128 changes: 0 additions & 128 deletions doc/index.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 664319c

Please sign in to comment.