Kelson has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/295035 )
Change subject: Convert READMEs to markdown. ...................................................................... Convert READMEs to markdown. Change-Id: I596bec7ef70bd0a7d45ba67d4fa313d93c861890 --- A README.md D zimlib/README A zimlib/README A zimlib/README.md D zimreader-java/README A zimreader-java/README.md D zimreader/README A zimreader/README.md A zimwriterdb/README.md R zimwriterfs/README.md 10 files changed, 100 insertions(+), 61 deletions(-) Approvals: Kelson: Verified; Looks good to me, approved diff --git a/README.md b/README.md new file mode 100644 index 0000000..c5fee8e --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +This OpenZIM project repository contains the sources for: +* [zimlib](./zimlib#readme): A library for reading and writing ZIM files. +* [zimwriterfs](./zimwriterfs#readme): A tool for creating ZIM files based on + contents on a local filesystem. +* [zimreader-java](./zimreader-java#readme): A ZIM reader written in Java. + +Old code, provided for archive purposes: +* [zimreader](./zimreader#readme): An old reader for the Zeno file format, the + predecessor to the ZIM file format. +* [zimwriterdb](./zimwriterdb#readme): Demonstrates how to write a ZIM file + based on data in a database. diff --git a/zimlib/README b/zimlib/README deleted file mode 100644 index e12d9c0..0000000 --- a/zimlib/README +++ /dev/null @@ -1,6 +0,0 @@ -The zimlib is the standard implementation of the ZIM specification. It -is a library which implements the read and write method for ZIM -files. The zimlib is released under the GPLv2 license terms. Use the -zimlib in your own software - like reader applications - to make them -ZIM-capable without the need having to dig too much into the ZIM file -format. diff --git a/zimlib/README b/zimlib/README new file mode 120000 index 0000000..42061c0 --- /dev/null +++ b/zimlib/README @@ -0,0 +1 @@ +README.md \ No newline at end of file diff --git a/zimlib/README.md b/zimlib/README.md new file mode 100644 index 0000000..ce35ed9 --- /dev/null +++ b/zimlib/README.md @@ -0,0 +1,20 @@ +zimlib +------ + +The `zimlib` library is the standard implementation of the ZIM +specification. It is a library which implements read and write +methods for ZIM files. + +Use the zimlib in your own software --- for example, reader +applications --- to make them ZIM-capable without the need having to +dig too much into the ZIM file format. + +To build: +``` +./autogen.sh +./configure +make +``` + +The `zimlib` library is released under the GPLv2 license +terms. diff --git a/zimreader-java/README b/zimreader-java/README deleted file mode 100644 index 973e7b2..0000000 --- a/zimreader-java/README +++ /dev/null @@ -1,46 +0,0 @@ - -ZIMReader in Java -================= - - This is a port of the ZIMReader in Java. One - of the aims of this project is to enable mobile - users developing on Android, J2ME and other - platforms to use ZIM files and build offline - Wikipedia readers. - - I'll soon add a javadoc, in the mean time - you can go through the comments that I have - provided in the source code. Also, try running - the example ZIMTest.java. - - This code was built on Java 1.6 and has not - been tested on previous versions. However, I'll - do that soon on previous ones as well. In the - next release, I intend to provide an Ant file. - - If you find any bugs, please report them to - <aruneshmathur1990 at gmail.com> or visit the - IRC channel #openzim on Freenode and ping - 'gremmachook'. - - This library is licensed under the LGPL v3.0 - license. However, I understand that sometimes - licensing can be a problem for you. I would be - happy to provide a alternate lesser permissive - license if the need be. - - Found this library useful? Drop in a mail, I - love to hear feedback. - - Before this ends, I'd like to thank Lasse Collin - <Lasse.collin at tukaani.org>, who maintains the - Tukaani project, for his port of XZ in Java, - without which it wouldn't have been possible for - me to write this library. - - - -- Arunesh Mathur - <aruneshmathur1990 at gmail.com> - - - diff --git a/zimreader-java/README.md b/zimreader-java/README.md new file mode 100644 index 0000000..abce858 --- /dev/null +++ b/zimreader-java/README.md @@ -0,0 +1,42 @@ +ZIMReader in Java +================= + +This is a port of the ZIMReader in Java. One +of the aims of this project is to enable mobile +users developing on Android, J2ME and other +platforms to use ZIM files and build offline +Wikipedia readers. + +I'll soon add a javadoc, in the mean time +you can go through the comments that I have +provided in the source code. Also, try running +the example ZIMTest.java. + +This code was built on Java 1.6 and has not +been tested on previous versions. However, I'll +do that soon on previous ones as well. In the +next release, I intend to provide an Ant file. + +If you find any bugs, please report them to +<aruneshmathur1990 at gmail.com> or visit the +IRC channel #openzim on Freenode and ping +'gremmachook'. + +This library is licensed under the LGPL v3.0 +license. However, I understand that sometimes +licensing can be a problem for you. I would be +happy to provide a alternate lesser permissive +license if the need be. + +Found this library useful? Drop in a mail, I +love to hear feedback. + +Before this ends, I'd like to thank Lasse Collin +<Lasse.collin at tukaani.org>, who maintains the +Tukaani project, for his port of XZ in Java, +without which it wouldn't have been possible for +me to write this library. + + +-- Arunesh Mathur +<aruneshmathur1990 at gmail.com> diff --git a/zimreader/README b/zimreader/README deleted file mode 100644 index 5336df2..0000000 --- a/zimreader/README +++ /dev/null @@ -1,6 +0,0 @@ -TntReader -========= - -TntReader ist ein Server, mit dem sich die Daten von der deutschen -Wikipedia-DVD 2007 lesen lassen. Der Server stellt die Daten aus -den zeno-Dateien als Webseiten zur Verfügung. diff --git a/zimreader/README.md b/zimreader/README.md new file mode 100644 index 0000000..fb5268d --- /dev/null +++ b/zimreader/README.md @@ -0,0 +1,12 @@ +TntReader +========= + +TntReader ist ein Server, mit dem sich die Daten von der deutschen +Wikipedia-DVD 2007 lesen lassen. Der Server stellt die Daten aus +den zeno-Dateien als Webseiten zur Verfügung. + +TntReader is a server from which the data from the German +Wikipedia-DVD 2007 are read. The server provides the data +from Zeno files as Web pages. + +*THIS IS VERY OLD CODE AND HAS SINCE BEEN SUPERCEDED.* diff --git a/zimwriterdb/README.md b/zimwriterdb/README.md new file mode 100644 index 0000000..31af22e --- /dev/null +++ b/zimwriterdb/README.md @@ -0,0 +1,4 @@ +zimwriterdb +=========== + +This code demonstrates how to write a ZIM file based on data in a database. diff --git a/zimwriterfs/README b/zimwriterfs/README.md similarity index 84% rename from zimwriterfs/README rename to zimwriterfs/README.md index 811d4a8..797f6fb 100644 --- a/zimwriterfs/README +++ b/zimwriterfs/README.md @@ -1,3 +1,6 @@ +zimwriterfs +----------- + `zimwriterfs` is a console tool to create [ZIM](http://www.openzim.org) files from a locally-stored directory containing "self-sufficient" HTML content (with pictures, javascript, and stylesheets). The result will @@ -26,9 +29,12 @@ packaged), resp. for the mimeType detection * libz (http://www.zlib.net/), resp. for unpack compressed HTML files +Once the dependencies are in place, to build: +``` ./autogen.sh ./configure make +``` OSX compilation ---------------- @@ -37,6 +43,7 @@ You must have a working and set up Kiwix repository (with dependencies ready). 1. Install libmagic with brew (it's important) - - ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" - - brew install libmagic -2. KIWIX_ROOT=/Users/xxx/src/kiwix ./macosx-build.sh + - `ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"` + - `brew install libmagic` +2. Build kiwix: + - `KIWIX_ROOT=/Users/xxx/src/kiwix ./macosx-build.sh` -- To view, visit https://gerrit.wikimedia.org/r/295035 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I596bec7ef70bd0a7d45ba67d4fa313d93c861890 Gerrit-PatchSet: 2 Gerrit-Project: openzim Gerrit-Branch: master Gerrit-Owner: C. Scott Ananian <canan...@wikimedia.org> Gerrit-Reviewer: Kelson <kel...@kiwix.org> _______________________________________________ MediaWiki-commits mailing list MediaWiki-commits@lists.wikimedia.org https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
