mirror of
https://github.com/LibreELEC/LibreELEC.tv.git
synced 2025-07-29 05:36:47 +00:00
README: move to README.md, format in Markdown format
Signed-off-by: Stephan Raue <stephan@openelec.tv>
This commit is contained in:
parent
2c5e33677b
commit
a8c2615475
@ -1,6 +1,6 @@
|
|||||||
http://OpenELEC.tv
|
[OpenELEC](http://www.openelec.tv)
|
||||||
|
|
||||||
OpenELEC - Open Embedded Linux Entertainment Center
|
# OpenELEC - Open Embedded Linux Entertainment Center
|
||||||
|
|
||||||
OpenELEC runs XBMC, an award-winning free and open source (GPL) software media
|
OpenELEC runs XBMC, an award-winning free and open source (GPL) software media
|
||||||
player and entertainment hub for digital media (http://xbmc.org).
|
player and entertainment hub for digital media (http://xbmc.org).
|
||||||
@ -8,21 +8,26 @@ 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
|
efficient as possible – consuming only a tiny footprint, cutting edge hardware
|
||||||
support for a set-top box experience.
|
support for a set-top box experience.
|
||||||
|
|
||||||
Source code:
|
**Source code**
|
||||||
- https://github.com/OpenELEC/OpenELEC.tv
|
|
||||||
|
|
||||||
Installation:
|
* (https://github.com/OpenELEC/OpenELEC.tv)
|
||||||
- Please read INSTALL for instructions on how to install.
|
|
||||||
|
|
||||||
Known issues:
|
**Installation**
|
||||||
- Testing snapshot
|
|
||||||
|
|
||||||
License:
|
* Please read INSTALL for instructions on how to install.
|
||||||
- OpenELEC is released under GPLv2. Please refer to the "licenses" folder and
|
|
||||||
|
**Known issues**
|
||||||
|
|
||||||
|
* Testing snapshot
|
||||||
|
|
||||||
|
**License**
|
||||||
|
|
||||||
|
* OpenELEC is released under GPLv2. Please refer to the "licenses" folder and
|
||||||
source code for clarification on upstream licensing.
|
source code for clarification on upstream licensing.
|
||||||
|
|
||||||
Copyright:
|
**Copyright**
|
||||||
- Since OpenELEC includes code from many up stream projects it includes many
|
|
||||||
|
* Since OpenELEC includes code from many up stream projects it includes many
|
||||||
copyright owners. OpenELEC makes NO claim of copyright on any upstream code.
|
copyright owners. OpenELEC makes NO claim of copyright on any upstream code.
|
||||||
However all OpenELEC authored code is copyright openelec.tv.
|
However all OpenELEC authored code is copyright openelec.tv.
|
||||||
For a complete copyright list checkout the source code to examine the headers.
|
For a complete copyright list checkout the source code to examine the headers.
|
||||||
@ -37,43 +42,46 @@ Copyright:
|
|||||||
If you are submitting code that is not your own work it is the submitters
|
If you are submitting code that is not your own work it is the submitters
|
||||||
responsibility to place a header stating the copyright.
|
responsibility to place a header stating the copyright.
|
||||||
|
|
||||||
Features:
|
**Features**
|
||||||
- System size ~ 90 - 130MB
|
|
||||||
- Minimal hardware requirements
|
|
||||||
- Ultra fast boot
|
|
||||||
- Optimized builds for Atom, ION, Intel, Fusion
|
|
||||||
- Simple configuration via XBMC
|
|
||||||
- Plug and Play external storage
|
|
||||||
|
|
||||||
Software:
|
* System size ~ 90 - 130MB
|
||||||
- XBMC HTPC software – View/Manage all your media.
|
* Minimal hardware requirements
|
||||||
- Samba server – File transfer from any PC client
|
* Ultra fast boot
|
||||||
- SSH - remote debugging console
|
* Optimized builds for Atom, ION, Intel, Fusion
|
||||||
- IR/Bluetooth Remote Control
|
* Simple configuration via XBMC
|
||||||
|
* Plug and Play external storage
|
||||||
|
|
||||||
Notes:
|
**Software**
|
||||||
- Login details for SSH are user: “root” password: “openelec”.
|
|
||||||
|
* XBMC HTPC software – View/Manage all your media.
|
||||||
|
* Samba server – File transfer from any PC client
|
||||||
|
* SSH - remote debugging console
|
||||||
|
* 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
|
SSH allows command line access to your openelec.tv machine for configuration
|
||||||
and file transfer. Linux/mac clients can natively use SSH, windows users
|
and file transfer. Linux/mac clients can natively use SSH, windows users
|
||||||
might want to try PuTTY for their terminal access.
|
might want to try PuTTY for their terminal access.
|
||||||
- $HOME is mounted on /storage (the second ext4 partition on the drive).
|
* $HOME is mounted on /storage (the second ext4 partition on the drive).
|
||||||
All data transfered to the machine will go here, the rest of the system is
|
All data transfered to the machine will go here, the rest of the system is
|
||||||
read-only with the exception of /var (containing runtime configuration data).
|
read-only with the exception of /var (containing runtime configuration data).
|
||||||
- Manual update/downgrade procedure is as follows:
|
* Manual update/downgrade procedure is as follows:
|
||||||
Extract the snapshot and navigate to the 'target' directory.
|
Extract the snapshot and navigate to the 'target' directory.
|
||||||
Copy KERNEL and SYSTEM to the 'Update' network share (or /storage/.update) on
|
Copy KERNEL and SYSTEM to the 'Update' network share (or /storage/.update) on
|
||||||
your openelec machine. Your system will automatically upgrade during the
|
your openelec machine. Your system will automatically upgrade during the
|
||||||
next reboot.
|
next reboot.
|
||||||
- Automatic mounting of filesystems is supported. Devices such as USB Flash
|
* 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,
|
sticks can be plugged into a running machine and will be mounted to /media,
|
||||||
showing up in xbmc’s GUI.
|
showing up in xbmc’s GUI.
|
||||||
- Comments and questions are more than welcome, help is even better and patches
|
* Comments and questions are more than welcome, help is even better and patches
|
||||||
are absolutely perfect!!
|
are absolutely perfect!!
|
||||||
|
|
||||||
Questions/Support:
|
**Questions/Support**
|
||||||
- Forums on http://openelec.tv
|
|
||||||
- IRC chatroom #openelec on Freenode
|
|
||||||
|
|
||||||
Happy OpenELEC'ing
|
* Forums on [http://openelec.tv](http://openelec.tv)
|
||||||
|
* IRC chatroom **#openelec** on Freenode
|
||||||
|
|
||||||
|
**Happy OpenELEC'ing**
|
||||||
|
|
||||||
OpenELEC Development Team
|
|
@ -203,8 +203,8 @@ IMAGE_NAME="$DISTRONAME-$TARGET_VERSION"
|
|||||||
|
|
||||||
# create release dir
|
# create release dir
|
||||||
mkdir -p $RELEASE_DIR
|
mkdir -p $RELEASE_DIR
|
||||||
cp $ROOT/README $RELEASE_DIR
|
cp $ROOT/README* $RELEASE_DIR
|
||||||
cp $ROOT/CHANGELOG $RELEASE_DIR
|
cp $ROOT/CHANGELOG* $RELEASE_DIR
|
||||||
# cp -R $CONFIG/image/* $RELEASE_DIR
|
# cp -R $CONFIG/image/* $RELEASE_DIR
|
||||||
cp -R $CONFIG/release/* $RELEASE_DIR
|
cp -R $CONFIG/release/* $RELEASE_DIR
|
||||||
echo "$TARGET_VERSION" > $RELEASE_DIR/RELEASE
|
echo "$TARGET_VERSION" > $RELEASE_DIR/RELEASE
|
||||||
|
Loading…
x
Reference in New Issue
Block a user