Added changelog and README files

diff --git a/Changelog b/Changelog
new file mode 100644 (file)
index 0000000..1a9df4a
--- /dev/null
+++ b/Changelog
@@ -0,0 +1,12 @@
+Changelog for tv_grab_nl_java
+=============================
+
+tv_grab_nl_java-0.5 (unreleased)
+- kijkwijzer gefixt
+- categories vertaald naar mythtv standaard termen
+- teletekst ondertiteling, HD, breedbeeld, zwart-wit, herhaling nu in xmltv
+  uitvoer
+- de --configure optie geeft nu eerder gekozen kanalen als default
+
+tv_grab_nl_java-0.2 (2012-03-13)
+- Eerste release

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..22efda5
--- /dev/null
+++ b/README
@@ -0,0 +1,79 @@
+README for tv_grab_nl_java
+==========================
+
+English Summary
+---------------
+tv_grab_nl_java is an XMLTV-compatible grabber for Dutch television that uses TVGids.nl as a source.
+
+Algemeen
+--------
+tv_grab_nl_java is een XMLTV-compatibele grabber voor Nederlandse televisie die TVGids.nl 
+als bron gebruikt. tv_grab_nl_java is geschreven in Java en gebruikt de JSON-interface van 
+TVGids.nl.
+
+Kenmerken van tv_grab_nl_java:
+- detailinformatie wordt gecached
+- links naar zenderlogo's worden automatisch toegevoegd 
+- kijkwijzeraanbevelingen worden toegevoegd
+- --configure behoudt de zenderinstellingen van het oude configuratiebestand als default
+- geeft informatie over acteurs, presentatie, regisseur weer in xmltv
+- geschikt voor mythtv
+
+Installatie 
+-----------
+
+0. Het programma vereist Java7. Onder Debian te installeren met 'apt-get install openjdk-7-jre'.
+
+1. Download de .zip file (tv_grab_nl_java-VERSIE.zip) en pak 'm uit. Op Github te vinden via de URL
+   https://github.com/janpascal/tv_grab_nl_java/downloads
+
+2. Voor Linux-gebruikers: plaats de tv_grab_nl_java.jar file uit de zipfile 
+   in /usr/local/share/java/ en plaats tv_grab_nl_java in /usr/local/bin:
+   $ mv tv_grab_nl_java.jar /usr/local/share/java/
+   $ mv tv_grab_nl_java /usr/local/bin
+   $ chmod a+x /usr/local/bin/tv_grab_nl_java
+
+3. Voor Windows-gebruikers: heb ik geen verstand van
+
+Configuratie
+------------
+
+Je kunt tv_grab_nl_java configureren met de --configure optie. De tool haalt dan de beschikbare kanalen
+op van tvgid.nl en vraagt je van welke kanalen je de programmagegevens op wilt halen. 
+
+$ tv_grab_nl_java --configure
+
+Je hebt telkens de keus uit:
+- Y (yes): gebruik kanaal
+- N (no): gebruik kanaal niet
+- A (all): gebruik kanaal en alle volgende kanalen
+- none: gebruik kanaal en alle volgende kanalen niet
+- k (keep): gebruik voor dit en de volgende kanalen de keuzes van de vorige keer
+
+De configuratie wordt opgeslagen in het bestand $HOME/.xmltv/tv_grab_nl_java.conf. Je kunt dit bestand
+eventueel handmatig bewerken. Als je tv_grab_nl_java nogmaals aanroept met de --configure optie, dan
+worden je eerdere keuzes als default gebruikt. 
+
+Gebruik
+-------
+$ tv_grab_nl_java [opties]
+
+Beschikbare opties:
+--capabilities        Show grabber capabilities
+--description         Display a description to identify this grabber
+--help                Show this help
+--config-file <arg>   Configuration file location
+--cache <arg>         Cache file location
+--log-level <arg>     Set log level (0x0100=JSON, 0x0200=program info)
+--configure           Interactive configuration
+--output <arg>        Set xlmtv output filename
+--quiet               Be quiet
+--offset <arg>        Start day for grabbing (0=today)
+--days <arg>          Number of days to grab
+
+Voorbeeld:
+$ tv_grab_nl_java --offset 1 --days 2 --output uitvoer.xml
+Dit commando haalt de programma-informatie van de geselecteerde kanalen op voor morgen en overmorgen 
+en schrijft de resultaten weg in het bestand 'uitvoer.xml'.
+
+

diff --git a/pom.xml b/pom.xml
index 098f7ad3c004e73100917654bf562ed2f29fa8d1..707899c0b40de9dfeb47a280cd858f962b8b0165 100644 (file)
--- a/pom.xml
+++ b/pom.xml
@@ -3,7 +3,7 @@
        <modelVersion>4.0.0</modelVersion>
        <groupId>org.vanbest.xmltv.tv_grab_nl_java</groupId>
        <artifactId>tv_grab_nl_java</artifactId>
-       <version>0.0.1-SNAPSHOT</version>
+       <version>0.5.0-SNAPSHOT</version>
        <dependencies>
                <dependency>
                        <groupId>net.sf.json-lib</groupId>
@@ -42,7 +42,13 @@
                                <artifactId>maven-assembly-plugin</artifactId>
                                <version>2.3</version>
                                <configuration>
-                                       <descriptor>src/main/assembly/dep.xml</descriptor>
+                               <descriptors>
+                                    <descriptor>src/main/assembly/dep.xml</descriptor>
+                               </descriptors>
+                                <!--
+                                       <descriptorRefs>
+                                         <descriptorRef>jar-with-dependencies</descriptorRef>
+                                       </descriptorRefs> -->
                                        <archive>
                                                <manifest>
                                                        <mainClass>org.vanbest.xmltv.Main</mainClass>

diff --git a/src/main/assembly/dep.xml b/src/main/assembly/dep.xml
index 33cc6f4320ddcb0342e83db2f632b45bba171d33..432d1ddc284114da67ba4c40f1895cc742a3049f 100644 (file)
--- a/src/main/assembly/dep.xml
+++ b/src/main/assembly/dep.xml
@@ -1,30 +1,31 @@
 <assembly>
-  <!-- TODO: a jarjar format would be better -->
-  <id>dep</id>
-  <formats>
-    <format>jar</format>
-  </formats>
-  <includeBaseDirectory>false</includeBaseDirectory>
-  <fileSets>
-    <fileSet>
-      <includes>
-        <include>target/classes</include>
-      </includes>
-      <outputDirectory>/</outputDirectory>
-    </fileSet>
-  </fileSets>
-  <dependencySets>
-    <dependencySet>
-      <outputDirectory>/</outputDirectory>
-      <unpack>true</unpack>
-      <scope>runtime</scope>
-      <excludes>
-        <exclude>junit:junit</exclude>
-        <exclude>jsch:jsch</exclude>
-        <exclude>org.apache.maven.wagon:wagon-ssh</exclude>
-        <!-- TODO: can probably be removed now -->
-        <exclude>plexus:plexus-container-default</exclude>
-      </excludes>
-    </dependencySet>
-  </dependencySets>
+       <!-- TODO: a jarjar format would be better -->
+       <id>dep</id>
+       <formats>
+               <format>jar</format>
+       </formats>
+       <includeBaseDirectory>false</includeBaseDirectory>
+       <fileSets>
+               <fileSet>
+                       <includes>
+                               <include>**</include>
+                       </includes>
+                       <outputDirectory>/</outputDirectory>
+                        <directory>target/classes</directory>
+               </fileSet>
+       </fileSets>
+       <dependencySets>
+               <dependencySet>
+                       <outputDirectory>/</outputDirectory>
+                       <unpack>true</unpack>
+                       <scope>runtime</scope>
+                       <excludes>
+                               <exclude>junit:junit</exclude>
+                               <exclude>jsch:jsch</exclude>
+                               <exclude>org.apache.maven.wagon:wagon-ssh</exclude>
+                               <!-- TODO: can probably be removed now -->
+                               <exclude>plexus:plexus-container-default</exclude>
+                       </excludes>
+               </dependencySet>
+       </dependencySets>
 </assembly>