История изменений
Исправление Jullyfish, (текущая версия) :
У меня прям больших проектов нет. Есть работа, есть разные поделки, но в основном так:
-
На работе просто пишу в README.md, плюс, страничка на рабочей вики.
-
Просто текстовый файл в стиле, который у OpenBSD подсмотрел.
textwidth = 72, а заголовки следующим образом:
This is a title example
-----------------------
Regular paragraph. This command will fix your computer:
rm -rf /*
-
Создаю отдельную директорию
doc/и в ней пишу документацию в разметке markdown, но также она собирается в pdf с помощьюpandoc. А также добавляю LaTeX преамбулу. Иногда прям в markdown разметку добавляю LaTeX-команды. -
В начале программы в комментарии описать, а что собственно программа делает и какие подпрограммы ключевые.
Исходная версия Jullyfish, :
У меня прям больших проектов нет. Есть работа, есть разные поделки, но в основном так:
-
На работе просто пишу в README.md, плюс, страничка на рабочей вики.
-
Просто текстовый файл в стиле, который у OpenBSD подсмотрел.
textwidth = 72, а заголовки следующим образом:
This is a title example
-----------------------
Regular paragraph. This command will fix your computer:
rm -rf /*
- Создаю отдельную директорию
doc/и в ней пишу документацию в разметке markdown, но также она собирается в pdf с помощьюpandoc. А также добавляю LaTeX преамбулу. Иногда прям в markdown разметку добавляю LaTeX-команды.