Skip to content

Commit

Permalink
Readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
artyfarty committed Jan 24, 2012
1 parent c3ca867 commit 809aac8
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ UniversalEmoticonPackBuilder is a tool to build an emoticon packs for multiple c

For now QIP Infium/2010, Pidgin and Adium support is complete.

Licence: [Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported](http://creativecommons.org/licenses/by-nc-sa/3.0/)

## Solution projects
* UniversalEmoticonPackBuilder — console utility
* UniversalEmoticonPackBuilderLib — builder itself
Expand All @@ -11,7 +13,7 @@ For now QIP Infium/2010, Pidgin and Adium support is complete.
## Usage
First you need to create a pack to build. Check the *examplePack/* for a simple example.

Basically you need a **mapfile* and a **build config**.
Basically you need a **mapfile** and a **build config**.

### Mapfile
Mapfile defines which codes corresponds to emoticon images
Expand All @@ -33,4 +35,15 @@ Build config defines a basic metainfo of the pack and sets the name of the mapfi
}
```
You can also select which builders (clients) to use.
You can look up more builders in the source or write your own.
You can look up more builders in the source or write your own.

### Building
Now place mapfile, config and images in the same dir and point the console utility on the config:

```
uepackbuild "C:/blah blah/fooPack/config.json"
```

Or add **uepackbuild** to PATH and launch it from pack dir without params.

Congrats! Now you have *example_1.0_by_artyfarty_for_adium.zip*, *example_1.0_by_artyfarty_for_pidgin.zip* and *example_1.0_by_artyfarty_for_qip.zip* in *C:/blah blah/fooPack/build/* dir, ready for distribution.

0 comments on commit 809aac8

Please sign in to comment.