aboutsummaryrefslogtreecommitdiff
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
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
-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.
table. 2018-09-08setup.py: Bump to alpha4 for PyPIzlg1-1/+1 2018-09-08cli: add '--raw' option to list commandzlg2-9/+45 Add '--raw' option to the list command, in addition to proper note expansion. Newline characters in notes are escaped to be friendly to scripting. This option may be shortened to '-r' at the user's convenience. In raw output mode, the information is formatted in plain pipe-delimited strings, one line per row: title|system|ownership|progress|notes ownership and progress are printed in their numeric form, consistent with the OWNERSHIP and PROGRESS dictionaries in the vgstash package. An empty notes field will result in a line ending with a pipe and no whitespace following it. 2018-09-08Add remaining filters to vgstash packagezlg1-2/+11 2018-09-04Update LICENSE to match setup.pyzlg1-80/+67 Whoops. 2018-09-03Branch off from master with pytest, tox, clickzlg16-778/+779 This commit is huge, but contains everything needed for a "proper" build system built on pytest + tox and a CLI built with click. For now, this branch will contain all new vgstash development activity until it reaches feature parity with master. The CLI is installed to pip's PATH. Only the 'init', 'add', and 'list' commands work, with only two filters. This is pre-alpha software, and is therefore not stable yet. 2018-03-18Flesh out filter types and ownership statuszlg3-82/+144 It's time for a refactor to a module; the functionality and interface are clashing. 2018-03-18README.mdown: break line correctlyzlg1-1/+1 2018-03-18add 'playlog' list filterzlg2-2/+9 This filter is used to get an idea of which games you're currently playing through, so you can prioritize games to play when you're bored and detect it when you've beaten a game but haven't marked it as such. 2018-03-13Update helpers a bitzlg1-2/+9 At present, user modification is needed to make these seamless. vgup() may need to be axed in favor of telling the user to make an alias. 2018-03-13Make VGSTASH_DB_LOCATION point to a filezlg2-21/+20 It used to point to a directory, which would then look for .vgstash.db. This behavior was kind of backwards and I don't remember why I did it that way. This change gives users more control over where they put their DB. Be sure to update your environment variable if you have it set! 2016-11-18Remove settings from helpers.shZe Libertine Gamer1-5/+0 Sourcing them in .bash_profile screws up login if they're set. 2016-11-15Correct phrasing in README.Ze Libertine Gamer1-4/+4 2016-11-13DerpZe Libertine Gamer1-0/+1 2016-11-03Improve error handling in shell scriptsZe Libertine Gamer4-3/+23 2016-10-24Correct run_again, add recursionZe Libertine Gamer1-0/+4 Loops and functions -- oh my, what a useful combination. :) 2016-10-21Add quotes to correct behavior for arglistZe Libertine Gamer1-1/+1 2016-10-14updater.sh: add recursion, error handlingZe Libertine Gamer1-43/+101 2016-10-14Correct pipe-handling behaviorZe Libertine Gamer1-1/+9 2016-10-12Clarify a method to move between platformsZe Libertine Gamer1-2/+5 Also correct a typo.