Cosmetic changes

LICENSE.txt

@@ -0,0 +1,10 @@
+MIT License
+
+Copyright (C) 2016 Nikolay Nemshilov
+Copyright (C) 2022 Егор Гуслянцев
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,28 +1,25 @@
-# Keyboard Genetics
+# Keyboard Genetics RU
 
-This project is an attempt to discover and design the most efficient keyboard
-layout by using an evolution algorithm based AI.
+Попытка создать самую эффективную кириллическую раскладку при помощи эволюционного алгоритма.
 
-The project is officially finished and the final result can be found over here
+На данный момент не удаётся обогнать раскладку ЙУИЯФ.
 
-[Halmak](https://github.com/MadRabbit/halmak) keyboard layout.
+## Инструкция
 
-## Usage
+1. Склонировать репозиторий.
 
-1. Clone this repository
+2. Наполнить папку `text` файлами `*.txt`. Я использовал классические произведения
+   русской литературы, которые являются общественным достоянием.
 
-2. Create the `text` folder and fill it in with `*.txt` files which you'd like
-   to use as the test data source. I used a series of articles from various
-   online media. I don't have copyrights to provide them with this project, so
-   you will have to use your own source.
+3. Обработать каждый файл с помощью `convert.sh`. Файлы должны быть в кодировке *UTF-8*.
+   Удобно пройтись по каждому файлу с помощью цикла в оболочке командной строки.
 
-3. Run `npm start` to boot the AI design process. Exact constrains can be set
-   in the `src/genome.js` file.
+4. Сконфигурировать генератор. Настройки распологаются в файле `src/config.js`.
+   Можно сделать выбор не самого лучшего родителя для генерации нового поколения,
+   редактировать кривую уровня мутации, чтобы в начале не получить тупиковую ветку,
+   а в конце делать точечные правки, изменить размер популяции.
+   В файле `src/genome.js` возможно зафиксировать расположение некоторых букв.
 
-4. Run `npm test` to run the final comparisons against existing layouts
+5. Запустить генерацию командой `npm start`.
 
-## Copyright & License
-
-All code in this repo is released under the terms of the MIT license
-
-Copyright (C) 2016 Nikolay Nemshilov
+6. Добавить получившуюся раскладку в файл `src/compare.js` и сравнить с другими `npm test`.

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "keyboard-genetics",
+  "name": "keyboard-genetics-ru",
   "version": "1.0.0",
-  "description": "Genetic keyboard layout creator",
+  "description": "Genetic cyrillic keyboard layout creator",
   "private": true,
   "main": "src/index.js",
   "scripts": {
@@ -10,14 +10,14 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/MadRabbit/rockstar-genetics.git"
+    "url": "git+https://git.disroot.org/electromagneticcyclone/keyboard-genetics.git"
   },
   "author": "Nikolay Nemshilov",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/MadRabbit/rockstar-genetics/issues"
+    "url": "https://git.disroot.org/electromagneticcyclone/keyboard-genetics/issues"
   },
-  "homepage": "https://github.com/MadRabbit/rockstar-genetics#readme",
+  "homepage": "https://git.disroot.org/electromagneticcyclone/keyboard-genetics",
   "dependencies": {
     "blessed": "^0.1.81",
     "blessed-contrib": "^4.5.5",