--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README	Wed Jul 21 15:43:54 2010 +0800
@@ -0,0 +1,69 @@
+lm v0.1
+(c) Jérôme Poisson aka Goffi 2010
+
+lm is of software to list movies, loosely inspired from ls.
+
+
+
+** LICENSE **
+
+lm is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+lm is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with lm.  If not, see <http://www.gnu.org/licenses/>.
+
+
+
+** WTF ? **
+
+lm list media files (only movies so far), getting information on IMDb, allowing you to display sexy titles (instead of often unreadable filename), sort by rating, display plot, etc.
+
+
+
+** How to use it ? **
+
+lm --help
+
+each time you launch lm, it gets metadata for files it doesn't know, which is really slow. So, be sure to try on a directory with a few movies to test it.
+
+** Filters **
+
+you can filter your query using the --filter argument (or the short -f)
+Currently, you can filter on genre, director or actor.
+The syntax is --filter @keyword:filter,filter,filter@keyword2:filter,filter
+e.g.:
+lm --filter "@director:tim burton@genre:drama,fantasy"
+
+filters are case insensitive
+
+
+** Credit **
+
+Internet Movie Database (IMDb) is one of the oldest site on Internet, and, as its name says, give a lot of informations on movies
+
+IMDbPY:
+lm use IMDbPY to get information on IMDb (http://imdbpy.sourceforge.net/), many thanks to its authors
+
+
+
+** See also **
+
+You can also have a look on my other projets:
+- SàT: a XMMP client in heavy development, my main project at the moment
+- mkvconvert: a small script to convert mkv files unreadable with vlc to mkv with xvid
+
+
+
+** Contact **
+
+You can contact me on goffi@goffi.org
+You'll find the latest version on my website: http://www.goffi.org (it's mainly in french, I will probably make a little part in english in the future).
+