minor fixes of README.md

.gitignore

@@ -4,7 +4,7 @@ sections/*.log
 *.aux
 *.gz
 *.out
-astro-notebook.*
+astro-notebook*
 !style/astro-notebook.*
 !astro-notebook.tex
 .texpadtmp/

README.md

@@ -1,38 +1,38 @@
 # Астрадь
 
-В данном репозитории содержится исходный код будущего, уже третьего, издания Астради – сборника теории по астрономии. Стоит отметить, из определения Астради пропало слово "_краткий_". После печати второго издания було принято решение расширить круг тем и глубину их изложение и сделать третье, совершенно новое, издание.
+В данном репозитории содержится исходный код будущего, уже третьего, издания Астради – сборника теории по астрономии. Стоит отметить, из определения Астради пропало слово "_краткий_". После печати второго издания было принято решение расширить круг тем и глубину их изложение и сделать третье, совершенно новое, издание.
 
 ### Почему исходный код стал открытым?
 
-Я, Алексей Шепелев, основной автор Астради, к сожалению, пришел к неутешительному выводу: вряд ли смогу самостоятельно закончить начатое. На это есть несколько причин, основная – я все меньше занимаюсь астрономией и её преподаванием, вторичная – после окончания университета и появления основной работы не хватает времени для поддержания должного уровня знаний в астрономии.
+Я, Алексей Шепелев, основной автор Астради, к сожалению, пришёл к неутешительному выводу: вряд ли смогу самостоятельно закончить начатое. На это есть несколько причин, основная – я все меньше занимаюсь астрономией и её преподаванием, дополнительная – после окончания университета и устройства на основную работу не хватает свободного времени для поддержания должного уровня знаний в астрономии.
 
-Однако было бы грустно, если многие сотни часов работы над данным материалом будут закопаны, так и не принеся пользы. Поэтому было принято решение открыть репозиторий, чтобы любой желающий мог ознакомиться с **черновиками** и, быть может, узнать для себя что-то новое.
+Однако, было бы грустно, если бы многие сотни часов работы над данным материалом были закопаны, так и не принеся пользы. Поэтому было принято решение открыть репозиторий – сделать его публичным, чтобы любой желающий мог ознакомиться с **черновиками** и, быть может, узнать для себя что-то новое.
 
-Здесь важно подчеркнуть, что это именно черновики третьего издания. Конечно, все разделы имеют разную готовности: некоторые готовы полностью, некоторые остались нетронуты со второго издания и требуют доработки, некоторые написаны не полностью, где-то нет логической связи с другими разделами и пр. Но я уверен, ко ищет, тот найдет. Позже здесь в [README](README.md) появится список всех разделов с комментариями о готовности каждого. И описание планов по доработкам книги.
+Здесь важно подчеркнуть, что это именно черновики третьего издания. Конечно, разделы имеют разную степень готовности: некоторые готовы полностью, некоторые остались нетронуты со второго издания и требуют доработки, некоторые написаны не полностью, где-то нет логической связи с другими разделами и пр. Но я уверен, каждый сможет найти что-то интересное для себя в уже написанном. Позже здесь в [README](README.md) появится список всех разделов с комментариями о готовности каждого. 
 
 Мы готовы к соавторству! Подробнее см. в [соответствующем разделе](#соавторство) ниже. Давайте доделаем этот проект вместе! 
 
 ### Что нового?
-Пожалуй, не буду пегружать эту страницу, а лишь скажу, что в книге появилось предисловие от авторов. Там можно подробно ознакомиться о концепции книги, а задумке и мыслях авторов. Кто готов читать исходных код в LaTeX, то предисловие находится [здесь](sys/preface.tex).
+Пожалуй, не буду перегружать эту страницу, а лишь скажу, что в книге появилось предисловие от авторов. Там можно подробно ознакомиться о концепции книги, о задумке и мыслях авторов. Кто готов читать исходный код в LaTeX, предисловие находится [здесь](sys/preface.tex).
 
 ### Лицензия и ограничение на использование
 Этот проект лицензирован в соответствии с _Лицензией на использование в образовательных целях_. Код может использоваться только в образовательных целях. Подробнее см. в файле [LICENSE](LICENSE.txt).
 
-Ниже приведени инструкции как скачать уже собранных PDF файл, как собрать его самостоятельно и как можно поучаствовать в написании Астради.
+Ниже приведены инструкции, как скачать уже собранный PDF файл, как собрать его самостоятельно, и как принять участие в написании Астради.
 
 ## Как скачать PDF
 
 ### Самый простой способ
 
-Периодически в папку [/export](export) будут добавляться новые версии полностью скомпилированной книжки. Чтобы скачать файл, перейдя открыв данную папку, нужно
+Периодически в папку [/export](export) будут добавляться новые версии полностью скомпилированной книжки. Чтобы скачать файл,  открыв данную папку, нужно:
 
 1. Нажать на название нужной версии ![Нажмите на название нужной версии](readme/pdf/export/filename.png)
 2. В правом верхнем углу нажать на кнопку "Скачать" ![Скачать в правом верхнем углу](readme/pdf/export/download.png)
 
 ### Получить актуальную версию
-Своевременно появление версий в [/export](export) не гарантировано, так как происходит вручную. Однако в репозитории настроены автоматические действия при появлении нового коммита – собирается проект и результат доступен в виде PDF. Чтобы его скачать, нужно
+Своевременное появление версий в [/export](export) не гарантировано, так как происходит вручную. Однако, в репозитории настроены автоматические действия, запускаемые при появлении нового коммита – собирается проект, и результат доступен в виде PDF. Чтобы его скачать, нужно:
 1. Перейти во вкладку [Actions](https://github.com/AShepelevv/astro.notebook/actions). ![](readme/pdf/actions/actions-tab.png)
-2. Если интересуют только "стабильные" версии, можно воспользоваться фильтром по ветке и указать там master. [Ссылка на фильтр](https://github.com/AShepelevv/astro.notebook/actions?query=branch%3Amaster) ![](readme/pdf/actions/stable-version.png)
+2. Если интересуют только "стабильные" версии, можно воспользоваться фильтром по ветке и указать там `master`. [Ссылка на фильтр](https://github.com/AShepelevv/astro.notebook/actions?query=branch%3Amaster) ![](readme/pdf/actions/stable-version.png)
 3. Выбрать нужную сборку, например, ![](readme/pdf/actions/select-build.png)
 4. Внизу страницы будет блок "Artifacts", единственный артифакт – это pdf. Справа кнопка, которой можно его скачать
 ![](readme/pdf/actions/artifact.png)
@@ -46,7 +46,7 @@
 ### Системные требования
 
 * [Tex Live 2024](https://www.tug.org/texlive/acquire-netinstall.html), полная версия
-* Увеличить доступную оперативную память для LaTeX:
+* По умолчанию сборка происходит с включенным флагом `useLightPlotVersion`, что означает что несколько (~4-5) иллюстраций не будут отрисованы. Для полной сборки без флага `useLightPlotVersion` нужно увеличить доступную оперативную память для LaTeX:
   * Например, на Mac OS нужно в файл `~/Library/texmf/web2c/texmf.cnf` (создать, если его нет) записать следующее:
 
   ```
@@ -55,12 +55,14 @@
   extra_mem_top = 2000000
   param_size = 10000
   ```
+* Выключить флаг `useLightPlotVersion`, указав `false` в [его определении](https://github.com/AShepelevv/astro.notebook/blob/dda242ac37eaf0d64b5b30fe7ed7aa6400e9bade/astro-notebook.tex#L18)
 
 ### Запуск
-
+Для Linux и Mac OS достаточно запустить [скрипт](build.sh)
 ```bash
 sh build.sh
 ```
+На Windows нужно проделать эти действия самостоятельно.
 
 Прогресс первой сборки (очень долгой) можно смотреть по увеливению количества файлов в папке [tikz/resource](tikz/resource). Там будет храниться локальный кэш картинок, сгенерированных с помощью TikZ.
 
@@ -74,8 +76,8 @@ sh build.sh
 
 ### Как сделать правку?
 1. Нужно назначить issue  на себя, нажав на "assign yourself" в блоке справа ![assign yourself](readme/issue/assign.png)
-2. Создать ветку, нажав на "Create branch" в блоке справа, это нужно, чтобы issue автоматически привязалась к будущему PR ![create branch](readme/issue/create-branch.png)
-2. Сделать Pull Request в ветку master со своими правками, будем рады обсудить их и добавить в книжку.
+2. Создать ветку, нажав на "Create branch" в блоке справа. Это нужно, чтобы issue автоматически привязалась к будущему PR ![create branch](readme/issue/create-branch.png)
+2. Сделать Pull Request со своими правками в ветку `master`, будем рады обсудить правки и добавить их в книжку.
 
 ### Дополнительно
 Для разработки дополнительно к пунктам из раздела [Сборка](#сборка) может понадобиться:

build.sh

@@ -1,4 +1,4 @@
-mkdir -p tikz/resource
-xelatex -shell-escape astro-notebook.tex
-bibtex astro-notebook
-xelatex -shell-escape astro-notebook.tex
+mkdir -p tikz/resource                   # Создать папку tikz/resource, если её нет
+xelatex -shell-escape astro-notebook.tex # Собрать проект с помощью xelatex c опцией -shell-escape
+bibtex astro-notebook                    # Обработать библиографию с помощью bibtex
+xelatex -shell-escape astro-notebook.tex # Повторно собрать проект, чтобы обновилась библиография