From 8fcdbbbe73de71f7015218dc6c9e6cca4dbc8696 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A1szl=C3=B3=20Monda?= Date: Wed, 6 Apr 2016 03:19:01 +0200 Subject: [PATCH] Update README.md --- config-serializer/README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/config-serializer/README.md b/config-serializer/README.md index ee0ad831..e9b0a304 100644 --- a/config-serializer/README.md +++ b/config-serializer/README.md @@ -4,17 +4,17 @@ This directory contains the configuration serializer of Agent. The configuration of the UHK is unusually complex for a keyboard, 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! -## The 3 representations of the configuration +## Configuration representations There are 3 different representations of the configuration, each filling a specific purpose. -The **JavaScript representation** is optimally suited to be serialized as JSON, and saved to the file system, or transmitted over the network. As a plaintext format, it's human-readable and easily editable. +The **JavaScript representation** is optimally suited to be serialized as JSON, and saved to the file system, or transmitted over the network. As a plaintext format, it's human-readable and easily editable. See [uhk-config.json](uhk-config.json) for an example configuration. -The **TypeScript representation** is structurally similar to the JavaScript representation, but it features strongly typed TypeScript objects instead of typeless JavaScript objects. It's meant to be used by Agent. Extensive validation is taking place upon constructing the TypeScript objects, ensuring the integrity of the configuration. +The **TypeScript representation** is structurally similar to the JavaScript representation, but it features strongly typed TypeScript objects instead of typeless JavaScript objects. This representation is meant to be used by Agent. Extensive validation takes place upon constructing the TypeScript objects to ensure the integrity of the configuration. -The **binary representation** is meant to be written to, and read from the EEPROM of the UHK. It's supposed to be very compact in order to maximize the use of the 32kbyte EEPROM space. +The **binary representation** is meant to be written to, and read from the EEPROM of the UHK. It's designed to be very compact in order to maximize the use of the 32kbyte EEPROM space. -## Data types +## Configuration types Each configuration item belongs to a specific type. The following types are available: