From 267f8960d20bb24e2fba976f7dab0e1035ef0ce3 Mon Sep 17 00:00:00 2001 From: Stephan Raue Date: Fri, 19 Nov 2010 23:47:12 +0100 Subject: [PATCH] README: add rewritten README file, thanks much to ilya Signed-off-by: Stephan Raue --- README | 55 +++++++++++++++++++++++++++++++++++++++++++ config/image/README | 18 -------------- scripts/image_release | 3 ++- 3 files changed, 57 insertions(+), 19 deletions(-) create mode 100644 README delete mode 100644 config/image/README diff --git a/README b/README new file mode 100644 index 000000000..613a6e368 --- /dev/null +++ b/README @@ -0,0 +1,55 @@ +http://www.OpenELEC.tv + +The Open Embedded Linux Enterainment Center – OpenELEC.tv + +OpenELEC runs XBMC, a complete media center solution (xbmc.org). +The base system has been designed and built from the ground up to be as +efficient as possible – consuming only a tiny footprint, cutting edge +hardware support and a set-top box experience. + +Source code: +- http://sourceforge.net/projects/openelec/ + +Installation: +- Please read INSTALL for instructions how to install. + +Known issues: +- Testing snapshot + +Features: +- System size ~ 90MB +- Minimal hardware requirements +- Simple configuration + +Software: +- xbmc HTPC software – View/Manage all your media. +- samba server – File transfer from any PC client +- Transmission – bittorrent client +- IR/Bluetooth Remote Control + +Notes: +- Login details for SSH are user: “root” password: “openelec” + SSH allows command line access to your openelec.tv machine for configuration + and file transfer. Linux/mac clients can natively use SSH, windows users + might want to try PuTTY for their terminal access. +- $HOME is mounted on /storage (the second ext4 partition on the drive). All + data that you transfer to the machine will go here, the rest of the system is + read-only with the exception of /var (which contains runtime configuration + data). +- Manual update/downgrade procedure is as follows: + Extract the snapshot and navigate to the 'target' directory + Copy KERNEL and SYSTEM to the 'Update' network share (or /storage/.update) on + your openelec machine. + Your system will automatically upgrade during the next reboot. +- Automatic mounting of filesystems is supported. Devices such as USB Flash + Sticks can be plugged into a running machine and will be mounted to /media, + showing up in xbmc’s GUI. +- Comments and questions are more than welcome, help is even better and patches + are absolutely perfect!! + +Please visit http://www.openelec.tv or log onto our IRC chatroom #openelec on +freenode. + +Happy XBMC'ing + +OpenELEC.tv Development Team diff --git a/config/image/README b/config/image/README deleted file mode 100644 index fa8d29e56..000000000 --- a/config/image/README +++ /dev/null @@ -1,18 +0,0 @@ -This is an embedded Linux distribution based on the OpenELEC.tv Project. -(http://www.openelec.tv). - -The goal of this tarball is the testing of XBMC with the OpenELEC.tv -distribution. More information about OpenELEC.tv you can find on -http://www.openelec.tv. - -Sourcecode: - Sourcecode you can find on https://code.launchpad.net/~sraue/openelec/devel. - -Installation: - Please read INSTALL for instructions how to install. - -Known issues: -- find issue in this release - -ToDo: -- test this release diff --git a/scripts/image_release b/scripts/image_release index 9536b06c0..c18235948 100755 --- a/scripts/image_release +++ b/scripts/image_release @@ -13,10 +13,11 @@ RELEASE_DIR="target/OpenELEC-$TARGET_VERSION" # create release dir mkdir -p $RELEASE_DIR + cp $ROOT/README $RELEASE_DIR + cp $ROOT/CHANGELOG $RELEASE_DIR cp -R $CONFIG/image/* $RELEASE_DIR cp -R $CONFIG/release/* $RELEASE_DIR echo "$TARGET_VERSION" > $RELEASE_DIR/RELEASE - cp $ROOT/CHANGELOG $RELEASE_DIR mkdir -p $RELEASE_DIR/licenses cp $ROOT/licenses/* $RELEASE_DIR/licenses