Skip to content

Commit

Permalink
Update information about config usage ✨
Browse files Browse the repository at this point in the history
  • Loading branch information
Johannes Deml authored Jul 6, 2018
1 parent 03ef2ec commit b2d7b94
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,32 @@ This is a small tool to find all unique characters of a csv. The collected infor
This tool was developed to create font assets for textmesh pro with just the characters you need. This is especially useful for languages like korean, japanese or chinese.

### Input
* Has to be placed in "in/table.csv"
* Input file can be dfined in config.xml, default value is "in/example.csv"
* Languages are defined in columns, first column defines the language name (see [example.csv](in/example.csv))
* Column ID and Description will be ignored
* Newline (\n) and all emojis will be ignored

### Output
* Files are created in "out.ColumnName.txt
* Text files are created for each language and named "ColumnName.txt". Output path can be defined in config.xml
* One file per column, expecting to have one language per column

## Download
[latest release](https://github.com/JohannesDeml/CsvCharacterExtractor/releases)
## Requirements
* [Java Runtime environment](http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html)

## Download
* [latest release](https://github.com/JohannesDeml/CsvCharacterExtractor/releases)

## Run
* Windows: Doubleclick Run.bat
* Windows, Mac, Linux: Run `java -jar CsvCharacterExtractor.jar` in the terminal
### Config usage
* Paths can be relative, e.g. `in/example.csv`
* Paths can be absolute, e.g. `C:/Users/UserName/Documents/LanguageCharacterFiles/`
* Use forward slashes only `/`
## Example
[Example Spreadsheet](https://docs.google.com/spreadsheets/d/1WmGauAzcCyQu7OcOnFP2Ypx2x9xuJCclpf7p25cFpz0/edit#gid=1088591893)

## Roadmap
* Add gif showing the functionality
* Add a file to define all files that should be ignored (e.g. {,})
* Add a file to define common characters that should always be included in the list (e.g. 0,1,2,3,4,5,6,7,8,9)
* Document code
Expand Down

0 comments on commit b2d7b94

Please sign in to comment.