aboutsummaryrefslogtreecommitdiff
path: root/README.mdown
diff options
context:
space:
mode:
Diffstat (limited to 'README.mdown')
-rw-r--r--README.mdown6
1 files changed, 6 insertions, 0 deletions
diff --git a/README.mdown b/README.mdown
new file mode 100644
index 0000000..50f505c
--- /dev/null
+++ b/README.mdown
@@ -0,0 +1,6 @@
+# What is GIMPixel?
+
+GIMPixel is a set of brushes, palettes, and image templates designed to turn GIMP into an enjoyable piece of pixeling software. It's still in its infancy, so if you know a thing or two about configuring GIMP or would like to contribute brushes, palettes, or more, don't hesitate to join in!
+
+## Usage
+To use GIMPixel, you must run GIMP after changing the "GIMP2_DIRECTORY" environment variable. To do so, just run something like `GIMP2_DIRECTORY=.gimpixel gimp` and it should work without messing with your existing GIMP configuration.