summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README33
1 files changed, 33 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..ff11fc0
--- /dev/null
+++ b/README
@@ -0,0 +1,33 @@
+fedora-business-cards - for rendering Fedora contributor business cards
+Copyright (C) 2008 Ian Weller <ianweller@gmail.com>
+
+This program 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 2 of the License, or
+(at your option) any later version.
+
+This program 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 this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+===========================================================
+
+Most of the modules are self-documenting, and running the fedora-business-cards
+executable makes things significantly easier. The executable uses the cmdline
+frontend in fedora_business_cards.frontend, complete with optparse and all that
+fun stuff. However, even with it being easy to use, I'll soon be writing
+documentation to make it more clear on how to write your own frontend, if you
+like; theoretically, you don't even need to include it in frontend.py, but it'd
+certainly be nice.
+
+Known bugs:
+* certain glyphs aren't yet available in MgOpen Moderna. The art team is
+ working on that.
+
+-- Ian Weller
+ Oct 2008