Skip to content
This repository has been archived by the owner on Nov 9, 2019. It is now read-only.

Commit

Permalink
Improve readme and introduce markdown syntax
Browse files Browse the repository at this point in the history
  • Loading branch information
herve authored and alexpdp7 committed Aug 22, 2018
1 parent e7df0df commit 0f91230
Showing 1 changed file with 13 additions and 9 deletions.
22 changes: 13 additions & 9 deletions README → README.md
Original file line number Diff line number Diff line change
@@ -1,39 +1,43 @@
pychromecastweb
# pychromecastweb

pychromecastweb is a web application that allows you to browse parts of
the local filesystem and cast videos to a Chromecast.

This is in a very rough state. To do something, follow the instructions
below, go to /admin/, create a media source pointing to folders with
media files, go back to /, browse and cast.
below, go to `/admin/`, create a media source pointing to folders with
media files, go back to `/`, browse and cast.

You can also go to /admin/ to add Chromecasts manually, this is useful
You can also go to `/admin/` to add Chromecasts manually, this is useful
if you are running this on a wired network or the Chromecasts are in a
different subnet.

DEVELOPMENT
## DEVELOPMENT

```shell
$ pipenv install --python 3.6 -e .[dev]
$ pipenv run python manage.py migrate
$ pipenv run python manage.py createsuperuser
$ CAST_HOST=<ip of your host> pipenv run gunicorn -b 0.0.0.0:8000 pyccw.wsgi -w 4
```

Chromecasts seem to use Google's public DNS servers, so you need to
specify which host should the Chromecast use to reach the embedded web
server for media files.

INSTALLATION
## INSTALLATION

This will install it under your user account:

```shell
$ pip3 install --user git+https://github.com/alexpdp7/pychromecastweb.git
$ CAST_HOST=<ip of your host> django-admin migrate --settings pyccw.settings
$ CAST_HOST=<ip of your host> django-admin createsuperuser --settings pyccw.settings
$ gunicorn -b 0.0.0.0:8000 pyccw.wsgi -w 4
```

If ./.local/bin is not in your path, you might need to prepend it to the
If `./.local/bin` is not in your path, you might need to prepend it to the
gunicorn and django-admin commands

CONFIGURATION
## CONFIGURATION

Use PYCCW_LOG_LEVEL=(DEBUG|...) to configure log levels.
Use `PYCCW_LOG_LEVEL=(DEBUG|...)` to configure log levels.

0 comments on commit 0f91230

Please sign in to comment.