uhk/agent
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
László Monda
2016-04-09 15:37:12 +02:00
parent 3a7703571b
commit f946e98498
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
config-serializer/README.md
View File

@@ -4,6 +4,10 @@ This directory contains the configuration serializer of Agent.
The configuration of the UHK is unusually complex for a keyboard, and is composed of a number of items of different types, including keymaps, layers, macros, and the like. This is a supposed to be a short guide for the aspiring hacker. Let's get right into it!
## Setup
Given that the development dependencies are installed on your system you should be able to build the configuration serializer by executing `tsc` in this directory, then test it with `node test-serializer.js`.
## Configuration representations
There are 3 different representations of the configuration, each filling a specific purpose.