aboutsummaryrefslogtreecommitdiff
path: root/README.mdown
diff options
context:
space:
mode:
authorzlg <zlg@zlg.space>2021-10-17 13:43:04 -0700
committerzlg <zlg@zlg.space>2021-10-17 13:43:04 -0700
commitacd7f2221275cfd82ded2cf6b99803adac9631e1 (patch)
treea9978f07d92b52b3a50767d3ac4665c8283da9b0 /README.mdown
parentpalettes: add PICO-8 palette (diff)
downloadgimpixel-acd7f2221275cfd82ded2cf6b99803adac9631e1.tar.gz
gimpixel-acd7f2221275cfd82ded2cf6b99803adac9631e1.tar.bz2
gimpixel-acd7f2221275cfd82ded2cf6b99803adac9631e1.tar.xz
gimpixel-acd7f2221275cfd82ded2cf6b99803adac9631e1.zip
README.mdown: update URLs and improve structureHEADmaster
Diffstat (limited to 'README.mdown')
-rw-r--r--README.mdown21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.mdown b/README.mdown
index c38ba3f..a3ccecb 100644
--- a/README.mdown
+++ b/README.mdown
@@ -1,21 +1,33 @@
# What is GIMPixel?
-GIMPixel is a set of brushes, palettes, and image templates designed to turn [GIMP](http://gimp.org) 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!
+GIMPixel is a set of brushes, palettes, and image templates designed to turn
+[GIMP](http://gimp.org) 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!
For a quick look at what GIMPixel provides, check out the `features.png` file:
-![A summary of features that GIMPixel offers](https://github.com/sporkbox/gimpixel/raw/master/features.png "Isn't it awesome?")
+![A summary of features that GIMPixel
+offers](https://git.zlg.space/gimpixel/plain/features.png "Isn't it awesome?")
## 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.
-If you decide that you'd like to replace your existing GIMP configuration with GIMPixel, just move .gimpixel to your original GIMP directory (usually .gimp-2.x/)
+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.
+
+If you decide that you'd like to replace your existing GIMP configuration
+with GIMPixel, just move .gimpixel to your original GIMP directory (usually
+.gimp-2.x/)
### Fluxbox
+
Adding the following to ~/.fluxbox/menu should work:
`[exec] (GIMPixel) {GIMP2_DIRECTORY=~/.gimpixel gimp}`
### Bash script
+
Put the following into a text file and save it as an executable shell script:
#!/bin/bash
@@ -25,6 +37,7 @@ Put the following into a text file and save it as an executable shell script:
Name it something like `gimpixel` and you'll have a quicklauncher.
# Roadmap
+
* Support color bit-depth setting
* Provide execution directions for other common window managers or environments.
* Add some additional interesting or useful brushes.