doc: start rewrite

and3rson · Mar 9, 2024 · bb5a81b · bb5a81b
1 parent d23cd7a
commit bb5a81b
Show file tree

Hide file tree

Showing 59 changed files with 38 additions and 40 deletions.
diff --git a/docs/manual/assembly/components.rst → docs/assembly/components.rst b/docs/manual/assembly/components.rst → docs/assembly/components.rst
diff --git a/docs/manual/assembly/configurations.rst → docs/assembly/configurations.rst b/docs/manual/assembly/configurations.rst → docs/assembly/configurations.rst
diff --git a/docs/manual/assembly/index.rst → docs/assembly/index.rst b/docs/manual/assembly/index.rst → docs/assembly/index.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -14,9 +14,9 @@
 
     about/index
     hardware/index
+    assembly/index
     manual/index
     library/index
-    lua/index
     faq
     glossary
 

diff --git a/docs/manual/main_firmware/environment.rst → docs/manual/hashbrown/environment.rst b/docs/manual/main_firmware/environment.rst → docs/manual/hashbrown/environment.rst
diff --git a/docs/manual/main_firmware/features.rst → docs/manual/hashbrown/features.rst b/docs/manual/main_firmware/features.rst → docs/manual/hashbrown/features.rst
@@ -1,7 +1,7 @@
-.. _main-firmware-features:
+.. _hashbrown-firmware-features:
 
-Можливості основної прошивки
-============================
+Можливості Хешбраун OS
+======================
 
 .. contents::
    :local:
@@ -16,22 +16,22 @@
 
 Це має деякі великі переваги:
 
-- Ви можете використовувати більше пам'яті, ніж доступно в основній прошивці.
+- Ви можете використовувати більше пам'яті, ніж доступно в Хешбраун OS.
 - Вам не потрібно щоразу перепрошивати Лілку, щоб випробувати другорядні прошивки: просто скопіюйте їх на SD-картку.
-- Ви можете ділитися своїми скомпільованими прошивками (у вигляді ``.bin``-файлів) з іншими користувачами Лілки, без необхідності відправляти їм весь код вашої основної прошивки.
+- Ви можете ділитися своїми скомпільованими прошивками (у вигляді ``.bin``-файлів) з іншими користувачами Лілки, без необхідності відправляти їм весь код вашої власної прошивки.
 
 Найяскравіший приклад використання цієї функції - запуск Doom. Достатньо скопіювати в корінь SD-карти файли ``doom.bin`` і ``doom.wad`` (або ``doom1.wad``), і ви зможете грати в Doom!
 
 .. note:: Щоб отримати ``doom.bin``, вам потрібно скомпілювати прошивку, що знаходиться в папці ``firmware/doom``, і тоді скопіювати файл ``doom.bin`` на SD-картку.
 
 .. note::
 
-    Щоб отримати ``doom.wad``, ви можете завантажити безкоштовну shareware-версію Doom `за цим посиланням <https://distro.ibiblio.org/slitaz/sources/packages/d/doom1.wad>_`,
+    Щоб отримати ``doom.wad``, ви можете завантажити безкоштовну shareware-версію Doom `за цим посиланням <https://distro.ibiblio.org/slitaz/sources/packages/d/doom1.wad>`_,
     або ж мати повну ліцензійну копію Doom і витягти з неї файл ``doom.wad``.
 
 Тепер ви можете вставити SD-картку в Лілку і вибрати ``doom.bin`` у браузері SD-картки. Лілка перезавантажиться, і ви зможете зіграти в Doom!
 
-Після перезавантаження Лілки, ви повернетеся до основної прошивки.
+Після перезавантаження Лілки ви повернетеся до Хешбраун OS.
 
 .. _nes-emulator-feature:
 
@@ -51,7 +51,7 @@
 
 Для виконання Lua-скриптів Лілка використовує вбудований інтерпретатор Lua, який базується на `Lua 5.4.6 <https://www.lua.org/manual/5.4/manual.html>`_.
 
-Написати власний Lua-скрипт для Лілки дуже просто. Для цього вам потрібно знати основи Lua, а також використовувати :doc:`Lua API </lua/index>` Лілки.
+Написати власний Lua-скрипт для Лілки дуже просто. Для цього вам потрібно знати основи Lua, а також використовувати Lua API  Лілки. Детальніше про це - в розділі :ref:`lua-intro`.
 
 Детальніше про те, як писати Lua-скрипти для Лілки, ви можете прочитати в розділі :ref:`lua-intro`.
 

diff --git a/docs/manual/main_firmware/flashing.rst → docs/manual/hashbrown/flashing.rst b/docs/manual/main_firmware/flashing.rst → docs/manual/hashbrown/flashing.rst
@@ -1,14 +1,14 @@
-Запуск основної прошивки
-========================
+Запуск Хешбраун OS
+==================
 
 Лілка постачається з готовою прошивкою, яка вміє багато різних речей. Ця прошивка використовується для демонстрації можливостей Лілки, а також як приклад для розробки власних програм.
 
 TODO: links to features
 
-В цьому розділі ми розглянемо, як завантажити основну прошивку в Лілку.
+В цьому розділі ми розглянемо, як завантажити Хешбраун OS у в Лілку.
 
-Клонування репозиторію та побудова основної прошивки
------------------------------------------------------------
+Клонування репозиторію та побудова прошивки
+-------------------------------------------
 
 1. Перейдіть на вкладку **Source Control** (``Ctrl`` + ``Shift`` + ``G``) та клонуйте репозиторій `Lilka <https://github.com/and3rson/lilka>`_:
 
@@ -22,7 +22,7 @@ TODO: links to features
    .. image:: ./images/09_clone_cropped.png
        :width: 80%
 
-2. Після клонування репозиторію перейдіть на вкладку **PlatformIO** та імпортуйте проєкт основної прошивки для Лілки. Для цього натисніть "**Open Project**" та виберіть директорію ``lilka/firmware/main``.
+2. Після клонування репозиторію перейдіть на вкладку **PlatformIO** та імпортуйте проєкт прошивки Хешбраун OS для Лілки. Для цього натисніть "**Open Project**" та виберіть директорію ``lilka/firmware/hashbrown``.
 
    .. image:: ./images/11_open_pio_project_cropped.png
        :width: 80%
@@ -49,8 +49,8 @@ TODO: links to features
    .. image:: ./images/16_pio_build_ok_cropped.png
        :width: 80%
 
-Завантаження основної прошивки в Лілку
----------------------------------------------
+Завантаження прошивки в Лілку
+-----------------------------
 
 1. Підключіть Лілку до комп'ютера за допомогою USB-кабеля та увімкніть її.
 
@@ -83,14 +83,14 @@ TODO: links to features
 
         **Тепер вам не потрібно щоразу вручну переводити Лілку в режим завантаження, щоб завантажити нову прошивку!**
 
-        Крім основної прошивки ви щойно завантажили в Лілку ще й програму-завантажувач (bootloader). Тепер ви можете завантажувати нові прошивки в Лілку безпосередньо з **PlatformIO**.
+        Крім прошивки Хешбраун OS, ви щойно завантажили в Лілку ще й програму-завантажувач (bootloader). Тепер ви можете завантажувати нові прошивки в Лілку безпосередньо з **PlatformIO**.
 
         Просто натисніть кнопку ``Upload`` в **PlatformIO** та вона автоматично переведе Лілку в режим завантаження та завантажить нову прошивку!
 
 Вітаємо!
 --------
 
-Вітаємо, ви успішно налаштували середовище розробки та завантажили основну прошивку в Лілку!
+Вітаємо, ви успішно налаштували середовище розробки та завантажили Хешбраун OS в Лілку!
 
 Ви можете потицяти Лілку та переконатися, що вона працює і спробувати різні демо. Також ви можете перейти на вкладку **Explorer** (``Ctrl`` + ``Shift`` + ``E``), відкрити файл ``src/main.cpp`` та поглянути, як виглядає код прошивки, яку ми щойно зібрали і запустили на Лілці.
 

diff --git a/...in_firmware/images/01_download_vscode.png → ...l/hashbrown/images/01_download_vscode.png b/...in_firmware/images/01_download_vscode.png → ...l/hashbrown/images/01_download_vscode.png
diff --git a/...are/images/01_download_vscode_cropped.png → ...own/images/01_download_vscode_cropped.png b/...are/images/01_download_vscode_cropped.png → ...own/images/01_download_vscode_cropped.png
diff --git a/...main_firmware/images/02_inside_vscode.png → ...ual/hashbrown/images/02_inside_vscode.png b/...main_firmware/images/02_inside_vscode.png → ...ual/hashbrown/images/02_inside_vscode.png
diff --git a/...n_firmware/images/03_go_to_extensions.png → .../hashbrown/images/03_go_to_extensions.png b/...n_firmware/images/03_go_to_extensions.png → .../hashbrown/images/03_go_to_extensions.png
diff --git a/...firmware/images/04_install_platformio.png → ...ashbrown/images/04_install_platformio.png b/...firmware/images/04_install_platformio.png → ...ashbrown/images/04_install_platformio.png
diff --git a/.../images/04_install_platformio_cropped.png → .../images/04_install_platformio_cropped.png b/.../images/04_install_platformio_cropped.png → .../images/04_install_platformio_cropped.png
diff --git a/...rmware/images/05_installed_platformio.png → ...hbrown/images/05_installed_platformio.png b/...rmware/images/05_installed_platformio.png → ...hbrown/images/05_installed_platformio.png
diff --git a/...rmware/images/06_download_git_for_win.png → ...hbrown/images/06_download_git_for_win.png b/...rmware/images/06_download_git_for_win.png → ...hbrown/images/06_download_git_for_win.png
diff --git a/...mages/06_download_git_for_win_cropped.png → ...mages/06_download_git_for_win_cropped.png b/...mages/06_download_git_for_win_cropped.png → ...mages/06_download_git_for_win_cropped.png
diff --git a/...rmware/images/07_use_vs_code_with_git.png → ...hbrown/images/07_use_vs_code_with_git.png b/...rmware/images/07_use_vs_code_with_git.png → ...hbrown/images/07_use_vs_code_with_git.png
diff --git a/...mages/07_use_vs_code_with_git_cropped.png → ...mages/07_use_vs_code_with_git_cropped.png b/...mages/07_use_vs_code_with_git_cropped.png → ...mages/07_use_vs_code_with_git_cropped.png
diff --git a/...al/main_firmware/images/08_clone_repo.png → ...manual/hashbrown/images/08_clone_repo.png b/...al/main_firmware/images/08_clone_repo.png → ...manual/hashbrown/images/08_clone_repo.png
diff --git a/...firmware/images/08_clone_repo_cropped.png → ...ashbrown/images/08_clone_repo_cropped.png b/...firmware/images/08_clone_repo_cropped.png → ...ashbrown/images/08_clone_repo_cropped.png
diff --git a/.../manual/main_firmware/images/09_clone.png → docs/manual/hashbrown/images/09_clone.png b/.../manual/main_firmware/images/09_clone.png → docs/manual/hashbrown/images/09_clone.png
diff --git a/...main_firmware/images/09_clone_cropped.png → ...ual/hashbrown/images/09_clone_cropped.png b/...main_firmware/images/09_clone_cropped.png → ...ual/hashbrown/images/09_clone_cropped.png
diff --git a/...in_firmware/images/10_see_cloned_repo.png → ...l/hashbrown/images/10_see_cloned_repo.png b/...in_firmware/images/10_see_cloned_repo.png → ...l/hashbrown/images/10_see_cloned_repo.png
diff --git a/...n_firmware/images/11_open_pio_project.png → .../hashbrown/images/11_open_pio_project.png b/...n_firmware/images/11_open_pio_project.png → .../hashbrown/images/11_open_pio_project.png
diff --git a/...re/images/11_open_pio_project_cropped.png → ...wn/images/11_open_pio_project_cropped.png b/...re/images/11_open_pio_project_cropped.png → ...wn/images/11_open_pio_project_cropped.png
diff --git a/...mware/images/12_wait_pio_project_init.png → ...brown/images/12_wait_pio_project_init.png b/...mware/images/12_wait_pio_project_init.png → ...brown/images/12_wait_pio_project_init.png
diff --git a/.../images/13_wait_pio_project_init_more.png → .../images/13_wait_pio_project_init_more.png b/.../images/13_wait_pio_project_init_more.png → .../images/13_wait_pio_project_init_more.png
diff --git a/...13_wait_pio_project_init_more_cropped.png → ...13_wait_pio_project_init_more_cropped.png b/...13_wait_pio_project_init_more_cropped.png → ...13_wait_pio_project_init_more_cropped.png
diff --git a/.../main_firmware/images/14_pio_build_v2.png → ...nual/hashbrown/images/14_pio_build_v2.png b/.../main_firmware/images/14_pio_build_v2.png → ...nual/hashbrown/images/14_pio_build_v2.png
diff --git a/...rmware/images/14_pio_build_v2_cropped.png → ...hbrown/images/14_pio_build_v2_cropped.png b/...rmware/images/14_pio_build_v2_cropped.png → ...hbrown/images/14_pio_build_v2_cropped.png
diff --git a/...mware/images/15_pio_build_v2_progress.png → ...brown/images/15_pio_build_v2_progress.png b/...mware/images/15_pio_build_v2_progress.png → ...brown/images/15_pio_build_v2_progress.png
diff --git a/...ages/15_pio_build_v2_progress_cropped.png → ...ages/15_pio_build_v2_progress_cropped.png b/...ages/15_pio_build_v2_progress_cropped.png → ...ages/15_pio_build_v2_progress_cropped.png
diff --git a/.../main_firmware/images/16_pio_build_ok.png → ...nual/hashbrown/images/16_pio_build_ok.png b/.../main_firmware/images/16_pio_build_ok.png → ...nual/hashbrown/images/16_pio_build_ok.png
diff --git a/...rmware/images/16_pio_build_ok_cropped.png → ...hbrown/images/16_pio_build_ok_cropped.png b/...rmware/images/16_pio_build_ok_cropped.png → ...hbrown/images/16_pio_build_ok_cropped.png
diff --git a/...main_firmware/images/17_run_upload_v2.png → ...ual/hashbrown/images/17_run_upload_v2.png b/...main_firmware/images/17_run_upload_v2.png → ...ual/hashbrown/images/17_run_upload_v2.png
diff --git a/...mware/images/17_run_upload_v2_cropped.png → ...brown/images/17_run_upload_v2_cropped.png b/...mware/images/17_run_upload_v2_cropped.png → ...brown/images/17_run_upload_v2_cropped.png
diff --git a/...in_firmware/images/18_upload_progress.png → ...l/hashbrown/images/18_upload_progress.png b/...in_firmware/images/18_upload_progress.png → ...l/hashbrown/images/18_upload_progress.png
diff --git a/...are/images/18_upload_progress_cropped.png → ...own/images/18_upload_progress_cropped.png b/...are/images/18_upload_progress_cropped.png → ...own/images/18_upload_progress_cropped.png
diff --git a/docs/manual/main_firmware/images/cursor.png → docs/manual/hashbrown/images/cursor.png b/docs/manual/main_firmware/images/cursor.png → docs/manual/hashbrown/images/cursor.png
diff --git a/docs/manual/hashbrown/index.rst b/docs/manual/hashbrown/index.rst
@@ -0,0 +1,14 @@
+Хешбраун OS
+===========
+
+Лілка постачається з нашою власною прошивкою, яка називається **Хешбраун** (**Hashbrown**) і включає в себе основні функції для демонстрації можливостей пристрою.
+
+.. toctree::
+    :maxdepth: 3
+
+    environment
+    flashing
+    features
+    sdcard
+    lua/intro
+    lua/reference/index
diff --git a/.../main_firmware/images/select_com_port.png → .../hashbrown/lua/images/select_com_port.png b/.../main_firmware/images/select_com_port.png → .../hashbrown/lua/images/select_com_port.png
diff --git a/.../main_firmware/images/select_com_port.xcf → .../hashbrown/lua/images/select_com_port.xcf b/.../main_firmware/images/select_com_port.xcf → .../hashbrown/lua/images/select_com_port.xcf
diff --git a/...main_firmware/images/send_entire_file.png → ...hashbrown/lua/images/send_entire_file.png b/...main_firmware/images/send_entire_file.png → ...hashbrown/lua/images/send_entire_file.png
diff --git a/...l/main_firmware/images/serial_monitor.png → ...l/hashbrown/lua/images/serial_monitor.png b/...l/main_firmware/images/serial_monitor.png → ...l/hashbrown/lua/images/serial_monitor.png
diff --git a/...l/main_firmware/images/serial_monitor.xcf → ...l/hashbrown/lua/images/serial_monitor.xcf b/...l/main_firmware/images/serial_monitor.xcf → ...l/hashbrown/lua/images/serial_monitor.xcf
diff --git a/docs/manual/main_firmware/lua.rst → docs/manual/hashbrown/lua/intro.rst b/docs/manual/main_firmware/lua.rst → docs/manual/hashbrown/lua/intro.rst
@@ -40,7 +40,7 @@
 
 Ви можете зберегти цей код у файл з розширенням ``.lua`` на SD-картці, а потім виконати його, обравши його в браузері SD-картки.
 
-Повний перелік доступних модулів та їх функцій можна знайти в розділі :doc:`Lua API </lua/index>`.
+Повний перелік доступних модулів та їх функцій можна знайти в розділі :doc:`reference/index`.
 
 .. _lua-games:
 
@@ -143,7 +143,7 @@
 Щоразу, коли ви зберігаєте програму на SD-картці, ви повинні виймати її з Лілки, вставляти в комп'ютер, зберігати файл, виймати з комп'ютера, вставляти в Лілку, вибирати файл в браузері SD-картки, запускати програму, перевіряти, 
 в͟и̛п͜р͢а̵в̀л͟я̕т̴и͜ ̢п͟о̨м͘и̴л͢к͡и́,͝ ̕з́б͠е͞р͠і͞г͏а̢т͞и̧ ͘з̶н̛о̶в͢у̢,͡ ͡О НІ! Це - нестерпно і в нас немає часу на це!
 
-Саме тому основна прошивка має функцію, яка називається **Live Lua**. Вона дозволяє вам запускати Lua-код на Лілці через USB-кабель прямо з вашого комп'ютера, без необхідності зберігати його на SD-картці.
+Саме тому Хешбраун OS має функцію, яка називається **Live Lua**. Вона дозволяє вам запускати Lua-код на Лілці через USB-кабель прямо з вашого комп'ютера, без необхідності зберігати його на SD-картці.
 
 .. warning::
 

diff --git a/docs/lua/controller.rst → ...al/hashbrown/lua/reference/controller.rst b/docs/lua/controller.rst → ...al/hashbrown/lua/reference/controller.rst
diff --git a/docs/lua/display.rst → ...anual/hashbrown/lua/reference/display.rst b/docs/lua/display.rst → ...anual/hashbrown/lua/reference/display.rst
diff --git a/docs/lua/geometry.rst → ...nual/hashbrown/lua/reference/geometry.rst b/docs/lua/geometry.rst → ...nual/hashbrown/lua/reference/geometry.rst
diff --git a/docs/lua/gpio.rst → docs/manual/hashbrown/lua/reference/gpio.rst b/docs/lua/gpio.rst → docs/manual/hashbrown/lua/reference/gpio.rst
diff --git a/docs/lua/index.rst → .../manual/hashbrown/lua/reference/index.rst b/docs/lua/index.rst → .../manual/hashbrown/lua/reference/index.rst
diff --git a/docs/lua/lilka.rst → .../manual/hashbrown/lua/reference/lilka.rst b/docs/lua/lilka.rst → .../manual/hashbrown/lua/reference/lilka.rst
diff --git a/docs/lua/math.rst → docs/manual/hashbrown/lua/reference/math.rst b/docs/lua/math.rst → docs/manual/hashbrown/lua/reference/math.rst
diff --git a/docs/lua/resources.rst → ...ual/hashbrown/lua/reference/resources.rst b/docs/lua/resources.rst → ...ual/hashbrown/lua/reference/resources.rst
diff --git a/docs/lua/state.rst → .../manual/hashbrown/lua/reference/state.rst b/docs/lua/state.rst → .../manual/hashbrown/lua/reference/state.rst
diff --git a/docs/lua/util.rst → docs/manual/hashbrown/lua/reference/util.rst b/docs/lua/util.rst → docs/manual/hashbrown/lua/reference/util.rst
diff --git a/docs/manual/main_firmware/sdcard.rst → docs/manual/hashbrown/sdcard.rst b/docs/manual/main_firmware/sdcard.rst → docs/manual/hashbrown/sdcard.rst
@@ -36,8 +36,8 @@
 
 Перш ніж використовувати карту пам'яті з Лілкою, ви можете записати на неї демонстраційні програми.
 
-Вони знаходяться в директорії ``firmware/main/sdcard`` в репозиторії проєкту на GitHub.
+Вони знаходяться в директорії ``firmware/hashbrown/sdcard`` в репозиторії проєкту на GitHub.
 
-Підключіть карту пам'яті до комп'ютера та скопіюйте файли з директорії ``firmware/main/sdcard`` на карту пам'яті. Після цього відключіть карту пам'яті від комп'ютера та вставте її в Лілку.
+Підключіть карту пам'яті до комп'ютера та скопіюйте файли з директорії ``firmware/hashbrown/sdcard`` на карту пам'яті. Після цього відключіть карту пам'яті від комп'ютера та вставте її в Лілку.
 
 Коли Лілка запуститься, виберіть пункт "Браузер SD-карти" в головному меню і спробуйте запустити одну з Lua-програм! (Вони мають розширення ``.lua`` і синю іконку.
diff --git a/docs/manual/index.rst b/docs/manual/index.rst
@@ -4,7 +4,6 @@
 .. toctree::
     :maxdepth: 1
 
-    assembly/index
-    main_firmware/index
+    hashbrown/index
     development
     extension
diff --git a/docs/manual/main_firmware/index.rst b/docs/manual/main_firmware/index.rst