Документация?
fizruk opened this issue · comments
Проект уже достаточно объемный, но документация практически отсутствует.
Было бы неплохо увидеть:
- комментарии в коде;
- файл README;
- инструкции по сборке/установке;
- описание диалекта Refal, поддерживаемого компилятором;
- описание опций командной строки.
Без этой документации проект может быть запросто потерян.
Сделал небольшое описание в readme файле.
Для сборки и запуска должно быть вполне достаточно.
Комментарии в коде уже не модно, так что галочку отметил.
Описание диалекта языка можно найти в части пособия, описывающей Рефал-2.