-
Notifications
You must be signed in to change notification settings - Fork 20
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Cleanup, update and rearrange README.md
(Issue #69)
- Loading branch information
Showing
1 changed file
with
42 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,44 +1,60 @@ | ||
| XWMM - XBMC Web Media Manager | ||
| ==== | ||
|
|
||
| ### MAIN REPO (Master): | ||
| Will contain all of the developers and other contributors work which should come as patches from all corners and then picked and merged in other | ||
| Branched repositories for e.g. Frodo | ||
| XWMM is a cross platform tool to manage the XBMC Media Database. It is completely web based, so you don't need to install anything on your workstation to manage your media. | ||
|
|
||
| This tool is intended to facilitate the use of the XBMC media management features (media infos, media categorization, scraping, etc ...) | ||
|
|
||
| #### Useful Links | ||
| * [Releases](https://github.com/slash2009/XWMM/releases) | ||
| * [Support and Discussion](http://forum.xbmc.org/showthread.php?tid=188839) | ||
| * [Report an issue](https://github.com/slash2009/XWMM/issues) | ||
|
|
||
| - - - | ||
|
|
||
| ### DEVELOPERS NEEDED - We don't pay either hehe ;) | ||
| Please join XWMM, help this XBMC web-interface be nr#1, we need skilled developers which can help improve and add exciting new features to XWMM. | ||
|
|
||
| Information should be posted here and some rudimentary format about XWMM etc and extended as necessary. | ||
| - - - | ||
| ### DEVELOPERS NEEDED - We Don't pay either hehe ;) | ||
| Please join XWMM, Help this XBMC web-interface be nr#1, we need skilled developers which can help improve and add exciting new features to XWMM. | ||
|
|
||
| ### Installation Instructions | ||
|
|
||
| - Install XWMM: | ||
| - Download [XWMM](https://github.com/slash2009/XWMM/releases) | ||
| - Go to System > Add-ons | ||
| - Select **[Install from a zip file](http://wiki.xbmc.org/index.php?title=HOW-TO:Install_an_Add-on_from_a_zip_file "HOW-TO:Install an Add-on from a zip file")** | ||
|
|
||
| - Enable web interface: | ||
| - Go to System > Services > Webserver > Services | ||
| - Enable **Allow control XBMC via HTTP** | ||
| - Set **Web Interface** to XWMM *(optional)* | ||
|
|
||
| - Access XWMM: | ||
| - If you made XWMM the default web interface open your browser to http://*xbmc_ip*:*port*/ | ||
| - Otherwise open your browser to http://*xbmc_ip*:*port*/addons/webinterface.XWMM/ | ||
|
|
||
| - - - | ||
|
|
||
| ### SUBMITTING PATCHES AND PR's | ||
| The idea is to fork this repo work on your changes and make a pull request (PR) to XWMM Master Repo, it should contain some of the following: | ||
| ### Submitting patches and PRs | ||
| The idea is to fork this repo work on your changes and make a pull request (PR) to the **master** branch, it should contain some of the following: | ||
|
|
||
| * What Patch addresses, if its a bug-fix a feature or improvement or something else. | ||
| * What the patch addresses, if its a bug-fix a feature or improvement or something else. | ||
| * Any comments in code for what is not immediately obvious. | ||
|
|
||
| ## Note: | ||
| A pull request PR should be made to MASTER, (using Branches is ok if your going to make same PR to master) by using Master then your working with latest code and fixes. | ||
| Any work can then be easily Picked and pulled into branches if needed, especially if its a bug-fix. | ||
| #### What will happen to Patches & PR's | ||
| #### Note: | ||
| A pull request (PR) should be made to **master**, (using branches is ok if your going to make the same PR to master) by using master then your working with latest code and fixes. Any work can then be easily picked and pulled into branches if needed, especially if its a bug-fix. | ||
|
|
||
| #### What will happen to patches & PRs | ||
| * It will be reviewed and merged as soon as possible by someone who understands what's going on. | ||
|
|
||
| ### Support and Discussion | ||
| For Discussion and support with XWMM see: | ||
| - - - | ||
|
|
||
| XBMC Thread [XWMM - XBMC Web Media Manager](http://forum.xbmc.org/showthread.php?tid=188839 "XWMM - XBMC Web Media Manager Forum discussion") | ||
| ### To Do | ||
|
|
||
| ##### Bug reports/Feature requests: | ||
| Github issue tracker [Click here to submit an issue](https://github.com/slash2009/XWMM/issues "XWMM Bug reports or Feature requests") | ||
| Features not yet working (incomplete list): | ||
|
|
||
| - - - | ||
| Features not yet working (incomplete list) - Todo list: | ||
| * Managing genres and actors (although these can be changed on a per movie/TV/music basis) | ||
|
|
||
| * Changing artwork | ||
| * Managing, genres and actors (although these can be changed on a per movie/TV/music basis) | ||
| * The "Files" tab | ||
| Due to XBMC's current API not supporting the following features they will not be implemented: | ||
|
|
||
| - - - | ||
| Install Via Zip mode in XBMC. | ||
| - - - | ||
| * Changing artwork |