WIP
[evolve-layout.git] / README
blobcebe6f6c475c111a0e274259e9660749d0d8657b
1 Intro
2 =====
4 evolve-keyboard-layout is an evolutionary keyboard optimizer. 
6 It optimizes the keyboard layout based on several cost criteria by doing random mutations and keeping those which reduce the cost. 
8 Install
9 =======
11 Prerequisites: 
13 * Python 3.x: http://python.org/download
14 * Mercurial: http://mercurial.selenic.com/downloads/
16 hg clone https://bitbucket.org/ArneBab/evolve-keyboard-layout/
18 Usage
19 =====
21 Do an evolution and store the results in output.txt: 
23 ./evolution.py 
25 Additional options: 
27 ./evolution.py --help
28 ./check_neo.py --help
29 ./convert_text_between_layouts.py --help
30 ./regularity_check.py --help
31 ./textcheck.py --help