Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Обновленная версия на 21.06.2024 и исправление недочётов в стилях и тексте документации. #8

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from
Draft

Обновленная версия на 21.06.2024 и исправление недочётов в стилях и тексте документации. #8

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
52156bb
Убраны ссылки переключения между документами.
XidFanSan Feb 1, 2024
f2fba52
Создание документации для avrdude.
XidFanSan Mar 27, 2024
bc22126
Небольшое исправление.
XidFanSan Mar 27, 2024
f31b689
Merge branch 'main' of github.com:XidFanSan/lapki-docserver
XidFanSan Mar 27, 2024
aac9070
Исправление недочётов в документации.
XidFanSan Apr 10, 2024
c10e5df
Переделана часть документации и исправлены ошибки.
XidFanSan Apr 19, 2024
2bc155d
Исправление и доработка документации.
XidFanSan Apr 25, 2024
5ec5573
Удалены лишние ссылки на бутстрап.
XidFanSan Apr 27, 2024
063e624
Обновление документации:
XidFanSan May 8, 2024
fa7a0f4
Исправление недочетов.
XidFanSan May 13, 2024
6ae62a1
Мелкие исправления текста.
XidFanSan May 13, 2024
1fc6992
Исправления:
XidFanSan Jun 4, 2024
ed8f5a0
Добавлено описание для связей комментариев.
XidFanSan Jun 5, 2024
38d042e
Пояснение по поводу добавления avrdude в PATH
Roundabout1 Jun 10, 2024
b7a60bc
правки к разделу macOS
Roundabout1 Jun 10, 2024
4de19bf
краткая сводка о том, что такое avrdude
Roundabout1 Jun 10, 2024
3b3033a
avrdude не нужен при работе с удалённым загрузчиком
Roundabout1 Jun 10, 2024
d7188fc
напоминание об перезагрузке IDE
Roundabout1 Jun 10, 2024
c83ffc4
изменение конечной подсказки
Roundabout1 Jun 10, 2024
7d1f229
вынесение в подсказку
Roundabout1 Jun 10, 2024
53164d1
Инструкция по добавлению avrdude в папку с загрузчиком
Roundabout1 Jun 10, 2024
4b0925d
 
Roundabout1 Jun 10, 2024
76c86b8
Merge pull request #1 from Roundabout1/flasher
XidFanSan Jun 10, 2024
8001142
Исправление документации по AVRDude.
XidFanSan Jun 10, 2024
9694a6b
Очередное обновление доокументации.
XidFanSan Jun 20, 2024
0a1a915
Добавление описания о Ctrl+D
XidFanSan Jun 25, 2024
115505d
Дополнение документации.
XidFanSan Jun 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions docs/00 Введение/00 О документации.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
</head>
<body class="mx-3">
<span class="badge text-bg-primary mt-3">00. Введение</span>
<span class="badge text-wrap text-bg-primary mt-3">00. Введение</span>
<h1 class="display-6 mt-3">00. О&nbsp;документации</h1>
<p class="mt-3">Разделы документации посвящены различным темам, с&nbsp;которыми вы столкнётесь при работе с&nbsp;IDE. Познакомимся с&nbsp;ними:</p>
<ul class="list-group list-group-flush">
<li class="list-group-item list-group-item-primary"><strong>00. Введение</strong>&nbsp;— пояснения к&nbsp;документации и&nbsp;пошаговый экскурс о&nbsp;работе с&nbsp;IDE;</li>
<li class="list-group-item"><strong>01. Работа с&nbsp;редактором</strong>&nbsp;— описание работы с&nbsp;редактором IDE;</li>
<li class="list-group-item"><strong>02. Работа с&nbsp;компилятором</strong>&nbsp;— описание, как&nbsp;работать со&nbsp;схемами из&nbsp;игры «Берлога: Защита пасеки» в&nbsp;IDE;</li>
<li class="list-group-item"><strong>03. Работа с&nbsp;загрузчиком</strong>&nbsp;— про&nbsp;взаимодействие Arduino и&nbsp;IDE;</li>
<li class="list-group-item"><strong>04. Дополнительные материалы</strong>&nbsp;— рекомендовано разработчиками для&nbsp;изучения таких тем, как&nbsp;инженерия, программирование, электроника.</li>
<li class="list-group-item"><strong>01. Клиентская часть IDE</strong>&nbsp;— подробное описание интерфейса и функциональности IDE;</li>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
<li class="list-group-item"><strong>02. Работа с&nbsp;редактором</strong>&nbsp;— описание работы с&nbsp;редактором IDE;</li>
<li class="list-group-item"><strong>03. Работа с&nbsp;компилятором</strong>&nbsp;— описание, как&nbsp;работать со&nbsp;схемами из&nbsp;игры «Берлога: Защита пасеки» в&nbsp;IDE;</li>
<li class="list-group-item"><strong>04. Работа с&nbsp;загрузчиком</strong>&nbsp;— про&nbsp;взаимодействие Arduino и&nbsp;IDE;</li>
<li class="list-group-item"><strong>05. Дополнительные материалы</strong>&nbsp;— рекомендовано разработчиками для&nbsp;изучения таких тем, как&nbsp;инженерия, программирование, электроника.</li>
</ul>
<p class="mt-5 text-bg-success p-2"><em>Спасибо, что&nbsp;пользуетесь нашей IDE!</em></p>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-HwwvtgBNo3bZJJLYd8oVXjrBZt8cqVSpeBNS5n7C8IVInixGAoxmnlMuBnhbgrkm" crossorigin="anonymous"></script>
Expand Down
18 changes: 9 additions & 9 deletions docs/00 Введение/01 Начало работы.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,21 @@
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
</head>
<body class="mx-3">
<span class="badge text-bg-primary mt-3">00. Введение</span>
<span class="badge text-wrap text-bg-primary mt-3">00. Введение</span>
<h1 class="display-6 mt-3">01. Начало работы</h1>
<p class="mt-3">Для начала рассмотрим каждый элемент экрана IDE.</p>
<p class="mt-3">В&nbsp;<strong>основном поле</strong> располагается открытая <mark>машина состояний</mark>, здесь&nbsp;же происходит работа с&nbsp;ней и&nbsp;её&nbsp;<mark>кодом</mark>.</p>
<p class="mb-1">На&nbsp;<strong>левой панели</strong> сверху вниз расположены иконки меню:</p>
<p class="mt-3">В&nbsp;<strong>графической области</strong> располагается открытая <mark>машина состояний</mark>, здесь&nbsp;же происходит работа с&nbsp;ней и&nbsp;её&nbsp;<mark>кодом</mark>.</p>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
<p class="mb-1">На&nbsp;<strong>левой панели</strong> сверху вниз расположены разделы меню:</p>
<ol class="list-group list-group-numbered">
<li class="list-group-item"><u>Главное меню</u>&nbsp;— включает в&nbsp;себя <mark>создание </mark> схем, <mark> открытие</mark> файлов, <mark>импорт</mark> схемы из&nbsp;игры «Берлога: Защита пасеки», <mark>сохранение</mark> текущего проекта&nbsp;в файл, а&nbsp;также <mark>готовые примеры</mark> для&nbsp;тренировки;</li>
<li class="list-group-item"><u>Проводник</u>&nbsp;— через это меню происходят действия с&nbsp;<mark>компонентами</mark> машины состояний;</li>
<li class="list-group-item"><u>Меню компилятора</u>&nbsp;— <mark>преобразование</mark> схемы машины состояний в&nbsp;формат выбранной целевой платформы;</li>
<li class="list-group-item"><u>Меню загрузчика</u>&nbsp;— <mark>загрузка</mark> скомпилированной схемы машины состояний в&nbsp;подключенное устройство;</li>
<li class="list-group-item"><u>Меню истории изменений</u>&nbsp;— <mark>возврат или отмена</mark> последних действий в&nbsp;редакторе IDE, а&nbsp;также их&nbsp;краткое <mark>описание</mark>;</li>
<li class="list-group-item"><u>Меню настроек</u>&nbsp;— содержит <mark>настраиваемые элементы</mark> IDE, например, тема приложения, выбор хоста и&nbsp;порта для&nbsp;компилятора и&nbsp;т.д.</li>
<li class="list-group-item"><u>Проводник</u>&nbsp;— через это меню происходят действия с&nbsp;<mark>компонентами</mark> машины состояний, а&nbsp;также&nbsp;здесь присутствует иерархия состояний для&nbsp;удобной работы с&nbsp;элементами машины состояний;</li>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
<li class="list-group-item"><u>Компилятор</u>&nbsp;— <mark>преобразование</mark> схемы машины состояний в&nbsp;формат выбранной целевой платформы;</li>
<li class="list-group-item"><u>Загрузчик</u>&nbsp;— <mark>загрузка</mark> скомпилированной схемы машины состояний в&nbsp;подключенное устройство;</li>
<li class="list-group-item"><u>История изменений</u>&nbsp;— <mark>возврат или отмена</mark> последних действий в&nbsp;редакторе IDE, а&nbsp;также их&nbsp;краткое <mark>описание</mark>;</li>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
<li class="list-group-item"><u>Настройки</u>&nbsp;— содержит <mark>настраиваемые элементы</mark> IDE, например, тема приложения, выбор хоста и&nbsp;порта для&nbsp;компилятора и&nbsp;т.д.</li>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
</ol>
<p class="mt-3">На&nbsp;<strong>верхней панели</strong> находятся <mark>вкладки переключения</mark> машины состояния и&nbsp;её&nbsp;кода&nbsp;— таким образом, вам будет удобно работать с&nbsp;машиной состояния и&nbsp;во&nbsp;вкладке с&nbsp;кодом смотреть, как&nbsp;элементы превращаются в&nbsp;распознаваемый «Берлогой: Защитой пасеки» и&nbsp;устройствами код.</p>
<p class="mt-3"><strong>Правая панель</strong> открывается с&nbsp;помощью клика на&nbsp;блок со&nbsp;стрелкой и&nbsp;содержит <mark>справку</mark> и&nbsp;<mark>документацию</mark> по&nbsp;работе с&nbsp;IDE.</p>
<p class="mt-3"><strong>Правая панель</strong> открывается с&nbsp;помощью клика на&nbsp;знак вопроса в&nbsp;правом нижнем углу экрана, который содержит <mark>справку</mark> по&nbsp;работе с&nbsp;IDE.</p>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-HwwvtgBNo3bZJJLYd8oVXjrBZt8cqVSpeBNS5n7C8IVInixGAoxmnlMuBnhbgrkm" crossorigin="anonymous"></script>
</body>
</html>
3 changes: 1 addition & 2 deletions docs/00 Введение/02 Руководство «Защита пасеки».html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>02. Руководство «Берлога: Защита пасеки»</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.min.css">
</head>
<body class="mx-3">
<span class="badge text-bg-primary mt-3">00. Введение</span>
<span class="badge text-wrap text-bg-primary mt-3">00. Введение</span>
<h1 class="display-6 mt-3">02. Руководство «Берлога: Защита пасеки»</h1>
<p class="mt-3">Научимся пошагово работать со&nbsp;схемой → с&nbsp;платформой <strong>«Берлога: Защита пасеки»</strong> в&nbsp;IDE.</p>
<!-- <p class="mt-3 text-bg-warning p-2">
Expand Down
3 changes: 1 addition & 2 deletions docs/00 Введение/03 Руководство Arduino.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>03. Руководство Arduino</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/font/bootstrap-icons.min.css">
</head>
<body class="mx-3">
<span class="badge text-bg-primary mt-3">00. Введение</span>
<span class="badge text-wrap text-bg-primary mt-3">00. Введение</span>
<h1 class="display-6 mt-3">03. Руководство Arduino</h1>
<p class="mt-3">Научимся пошагово работать со&nbsp;схемой → с&nbsp;платформой <strong>Arduino</strong> в&nbsp;IDE.</p>
<!-- <p class="mt-3 text-bg-warning p-2">
Expand Down
26 changes: 26 additions & 0 deletions docs/01 Интерфейс среды/00 Введение.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>00. Введение</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
</head>
<body class="mx-3">
<span class="badge text-wrap text-bg-primary mt-3">
01. Интерфейс
</span>
<h1 class="display-6 mt-3">
00. Введение
</h1>
<p class="mt-3">В&nbsp;начале работы Вы&nbsp;уже&nbsp;ознакомились с&nbsp;основными областями IDE, но&nbsp;давайте теперь подробнее их&nbsp;изучим.</p>
<p class="mt-3">Интерфейс IDE состоит:</p>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
<ul class="list-group list-group-flush">
<li class="list-group-item"><strong>01. Меню</strong>&nbsp;— описание основных разделов меню и что в них находится;</li>
<li class="list-group-item"><strong>02. Вкладки</strong>&nbsp;— описание области вкладок;</li>
<li class="list-group-item"><strong>03. Графическая область</strong>&nbsp;— описание графической области редактора и что там есть полезного;</li>
<li class="list-group-item"><strong>04. Документация</strong>&nbsp;— описание области документации.</li>
</ul>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-HwwvtgBNo3bZJJLYd8oVXjrBZt8cqVSpeBNS5n7C8IVInixGAoxmnlMuBnhbgrkm" crossorigin="anonymous"></script>
</body>
</html>
32 changes: 32 additions & 0 deletions docs/01 Интерфейс среды/01 Главное меню/00 Введение.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>00. Введение</title>
<link href="https://cdn.jsdelivr.net/npm/[email protected]/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-4bw+/aepP/YC94hEpVNVgiZdgIC5+VKNBQNGCHeKRQN+PtmoHDEXuppvnDJzQIu9" crossorigin="anonymous">
</head>
<body class="mx-3">
<span class="badge text-wrap text-bg-primary mt-3">
01. Интерфейс -> 01. Главное меню
</span>
<h1 class="display-6 mt-3">
00. Введение
</h1>
<p class="mt-3">
Слева от графической области IDE находится <strong>Главное меню</strong>.
</p>
<p class="mt-3">
Данное меню предназначено для взаимодействия с IDE. Изучим каждый раздел главного меню:
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
</p>
<ol class="list-group list-group-numbered">
<li class="list-group-item"><u>Главное меню</u>&nbsp;— включает в&nbsp;себя <mark>создание </mark> схем, <mark> открытие</mark> файлов, <mark>импорт</mark> схемы из&nbsp;игры «Берлога: Защита пасеки», <mark>сохранение</mark> текущего проекта&nbsp;в файл, а&nbsp;также <mark>готовые примеры</mark> для&nbsp;тренировки;</li>
XidFanSan marked this conversation as resolved.
Show resolved Hide resolved
<li class="list-group-item"><u>Проводник</u>&nbsp;— через это меню происходят действия с&nbsp;<mark>компонентами</mark> машины состояний, а&nbsp;также&nbsp;здесь находится иерархия состояний для&nbsp;удобной работы с&nbsp;элементами машины состояний;</li>
<li class="list-group-item"><u>Компилятор</u>&nbsp;— <mark>преобразование</mark> схемы машины состояний в&nbsp;формат выбранной целевой платформы;</li>
<li class="list-group-item"><u>Загрузчик</u>&nbsp;— <mark>загрузка</mark> скомпилированной схемы машины состояний в&nbsp;подключенное устройство;</li>
<li class="list-group-item"><u>История изменений</u>&nbsp;— <mark>возврат или отмена</mark> последних действий в&nbsp;редакторе IDE, а&nbsp;также их&nbsp;краткое <mark>описание</mark>;</li>
<li class="list-group-item"><u>Настройки</u>&nbsp;— содержит <mark>настраиваемые элементы</mark> IDE, например, тема приложения, выбор хоста и&nbsp;порта для&nbsp;компилятора и&nbsp;т.д.</li>
</ol>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/js/bootstrap.bundle.min.js" integrity="sha384-HwwvtgBNo3bZJJLYd8oVXjrBZt8cqVSpeBNS5n7C8IVInixGAoxmnlMuBnhbgrkm" crossorigin="anonymous"></script>
</body>
</html>
Loading