Merge branch 'master' into feature/analyzer-on-travis

# Conflicts:
#	.travis.yml
This commit is contained in:
Lucas Bickel 2017-03-04 16:35:11 +01:00
commit 188c127057
31 changed files with 372 additions and 199 deletions

14
docs/_css/term.css Normal file
View file

@ -0,0 +1,14 @@
pre.codehilite > code,
div.codehilite > pre {
color: #808080;
padding: 1em;
border-radius: 3px;
font-size: 110%;
font-weight: bold;
overflow: auto;
}
pre.codehilite > code.language-console > span,
div.codehilite > pre > span[style*="color: #AA22FF"] {
color: #808080 !important;
}

28
docs/documentation.md Normal file
View file

@ -0,0 +1,28 @@
Documentation
=============
The LibreTime documentation site is generated with [mkdocs](http://www.mkdocs.org/). To get started contributing to this project, fork it on Github. Then install mkdocs and clone this repo locally:
:::bash
sudo brew install python # For OSX users
sudo aptitude install python-pip # For Debian/Ubuntu users
sudo pip install mkdocs
git clone https://github.com/libretime/libretime
cd libretime
git remote add sandbox https://github.com/<username>/libretime # URL for your fork
mkdocs build --clean
mkdocs serve
Your local LibreTime docs site should now be available for browsing: [http://localhost:8888/](http://localhost:8888/).
When you find a typo, an error, unclear or missing explanations or instructions, open a new terminal and start editing. Your changes should be reflected automatically on the local server. Find the page youd like to edit; everything is in the docs/ directory. Make your changes, commit and push them, and start a pull request:
:::bash
git checkout -b fix_typo
vi docs/index.md # Add/edit/remove whatever you see fit. Be bold!
mkdocs build --clean; mkdocs serve # Go check your changes. Well wait...
git diff # Make sure there arent any unintended changes.
git commit -am”Fixed typo.” # Useful commit message are a good habit.
git push sandbox fix_typo
Visit your fork on Github and start a PR.

9
docs/features.md Normal file
View file

@ -0,0 +1,9 @@
Features
========
TBD
Screenshots
-----------
TBD

25
docs/index.md Normal file
View file

@ -0,0 +1,25 @@
Welcome to LibreTime
====================
LibreTime makes it easy to run your own online radio station. Check out some [features](features.md) and [screenshots](features.md#screenshots), then [install it](install.md) and start broadcasting!
LibreTime is Free/Libre and Open Source Software (FLOSS). Among other things, this means that you have the freedom to:
* Run it royalty-free for as long as you like.
* Read and alter the code that makes it work (or hire someone to do this for you!)
* Contribute documentation, bug-fixes, etc. so that everyone in the community benefits.
LibreTime is a fork of AirTime due to stalled development of the FLOSS version. For background on this, see this [open letter to the Airtime community](https://gist.github.com/hairmare/8c03b69c9accc90cfe31fd7e77c3b07d).
Getting Started
---------------
The easiest way to check out LibreTime for yourself is to run a local instance in a virtual machine. Assuming you already have Git, Vagrant and Virtualbox installed, just run:
:::bash
git clone https://github.com/libretime/libretime.git
cd libretime
vagrant up
Of course, this setup isn't appropriate for production use. For that, check out our [installation instructions](install.md).

9
docs/install.md Normal file
View file

@ -0,0 +1,9 @@
Installing LibreTime
====================
LibreTime should generally be installed on a dedicated host. By default, its installer will install and configure all its dependencies. At the moment, the installer works best on Ubuntu Trusty.
:::bash
./install
Plans are in the works for ```.deb``` and ```.rpm``` packages, as well as Docker and AWS images.

10
docs/scripts/install.sh Executable file
View file

@ -0,0 +1,10 @@
#! /bin/sh
echo "Updating Apt."
apt-get update > /dev/null
echo "Ensuring Pip is installed."
DEBIAN_FRONTEND=noninteractive apt-get install -y -qq python-pip > /dev/null
echo "Updating Pip."
pip install pip -q -q --upgrade > /dev/null
echo "Ensuring Mkdocs is installed."
pip install -q mkdocs > /dev/null

10
docs/scripts/serve.sh Executable file
View file

@ -0,0 +1,10 @@
#! /bin/sh
cd /vagrant
echo "Stopping any running Mkdocs servers."
pkill mkdocs
echo "Building Mkdocs documentation."
mkdocs build --clean -q > /dev/null
echo "Launching Mkdocs server."
mkdocs serve > /dev/null 2>&1 &
echo "Visit http://localhost:8888 to see the LibreTime documentation."