Files
shaka-player/docs/tutorials/welcome.md
T
Joey Parrish 9e571b3938 Update docs with regard to users list
The users list is now for announcements only.

Issue #1095

Change-Id: I4d86bfda5c116e88b950e2139a1c3d42afc91693
2017-10-30 15:28:16 -07:00

67 lines
1.8 KiB
Markdown

# Welcome to Shaka Player
Shaka Player is a JavaScript library for adaptive video streaming.
It plays [DASH][] content without browser plugins using
[MediaSource Extensions][] and [Encrypted Media Extensions][].
[DASH]: http://dashif.org/
[MediaSource Extensions]: http://w3c.github.io/media-source/
[Encrypted Media Extensions]: https://w3c.github.io/encrypted-media/
#### Prerequisites
You can build Shaka on Linux, Windows, or Mac.
To get the sources and compile the library, you will need:
* Git 1.7.10+ {@link https://git-scm.com/downloads}
* Python 2.7.x {@link https://www.python.org/downloads/}
* Java Runtime Environment 7+ {@link https://java.com/en/download/}
* A local web server
* _NOTE: A local web server is required because browsers place restrictions
on applications from file:/// URLs._
Additionally, to build the documentation and run the tests, you will need:
* npm v1.3.12+ {@link https://nodejs.org/en/download/}
To quickly install these prerequisites on Ubuntu or Debian, run:
```sh
sudo apt-get update
sudo apt-get install git python2.7 default-jre-headless npm
# Upgrade npm and node to the latest versions
sudo npm install -g n
sudo n stable
sudo npm install -g npm
```
Installation instructions for other operating systems are not provided here.
(We can't possibly document them all.) You can follow the links above to
download and install the prerequisites.
#### Get the source
```sh
git clone https://github.com/google/shaka-player.git
cd shaka-player
```
#### Compile the library
```sh
python build/all.py
```
#### Join the announcement list
If you want to receive release or survey announcements, you should join our
[mailing list](https://groups.google.com/forum/#!forum/shaka-player-users).
The list is very low volume.
#### Continue the Tutorials
Next, check out {@tutorial basic-usage}.