Skip to content

Commit

Permalink
table of contents (#119)
Browse files Browse the repository at this point in the history
table of contents
  • Loading branch information
pimnik98 authored Jan 19, 2024
2 parents c642836 + 7064dd3 commit fe834b0
Showing 1 changed file with 27 additions and 29 deletions.
56 changes: 27 additions & 29 deletions README_REALMD.MD
Original file line number Diff line number Diff line change
Expand Up @@ -16,36 +16,36 @@
Мы загружаем код на гитхаб каждый релиз. Сюда попадают стабильные версии исходных кодов и образов.

Содержание:
- Цели
- Скриншоты
- Системные требования
- План работ и прогресс
- Сборка
- Вклад в проект
- Программирование
- Тестирование
- Документирование
- Пиар
- Правовая информаиция
- Отказ от отвественности
- Контрибьюторы
- [Цели](#targets)
- [Скриншоты](#screenshots)
- [Системные требования](#sysrequirements)
- [План работ и прогресс](#roadmap)
- [Сборка](#build)
- [Вклад в проект](#contibution)
- [Программирование](#developers)
- [Тестирование](#testers)
- [Документирование](#techwriters)
- [Пиар](#adv)
- [Правовая информаиция](#legalinfo)
- [Отказ от отвественности](#denialofresponsibility)
- [Контрибьюторы](#contributors)

Огромное спасибо тем, кто поддерживает проект звездочками нашему проекту и контрибьюторам:

![Contributors](https://contrib.rocks/image?repo=pimnik98/SayoriOS)

## Цели
## <a id="targets">Цели</a>

[TODO]
Миниатюрная экспериментальная операционная система с графическим интерфейсом пользователя, защитой памяти и набором инструментов для системной и прикладной разработки изнутри ОС.

## Скриншоты
## <a id="screenshots">Скриншоты</a>

![Загрузочный экран](https://raw.githubusercontent.com/NDRAEY/SayoriOS/screens/screens/v0.3.2/1.png)
![Консоль](https://raw.githubusercontent.com/NDRAEY/SayoriOS/screens/screens/v0.3.2/2.png)
![Графический интерфейс](https://raw.githubusercontent.com/NDRAEY/SayoriOS/screens/screens/v0.3.2/3.png)
![Приложение](https://raw.githubusercontent.com/NDRAEY/SayoriOS/screens/screens/v0.3.2/4.png)

## Системные требования
## <a id="sysrequirements">Системные требования</a>

Ядро не требует много ресурсов:
- Процессор: x86_32 или x86_64 (1 ядро; 1 ГГц)
Expand All @@ -55,7 +55,7 @@
- Floopy-привод: (необязательно)
- Видеоадаптер: 4 MB+

## План работ и прогресс
## <a id="roadmap">План работ и прогресс</a>

| Компонент | Готовность | Примечания |
|-----------|------------|--------------------|
Expand Down Expand Up @@ -96,12 +96,10 @@
- Поддержка SAF ([В планах] Sayori Application File)
- Поддержка UEFI ([В планах] Запуск на оборудовании с UEFI)

## Сборка
## <a id="build">Сборка</a>

Для работы с ядром может потребоваться SayoriSDK: https://github.com/pimnik98/SayoriSDK

### Сборка ядра:

Для компиляции вам потребуется операционная система Linux, в которой предустановлено ПО для разработки.Установить можно следующей командой:

sudo apt-get install python3 clang llvm grub-pc-bin xorriso mtools lld git fasm make g++
Expand Down Expand Up @@ -140,11 +138,11 @@
make bir - Сборка ISO и запуск ядра
make WSL - Сборка ISO и запуск ядра через WSL

## Вклад в проект
## <a id="contibution">Вклад в проект</a>

Мы рады новым разработчикам и пользователям SayoriOS! Есть несколько способов, которыми вы можете внести свой вклад в проект:

### Если вы разработчик
### <a id="developers">Если вы разработчик</a>

Если вы разработчик, вы можете помочь, добавляя новые функции, устраняя ошибки или улучшая существующий код. Для этого вам нужно сделать следующее:

Expand All @@ -155,25 +153,25 @@

Мы будем рады вашим вкладам и готовы рассмотреть ваши Pull Request'ы.

### Если вы тестировщик
### <a id="testers">Если вы тестировщик</a>

Если вы нашли ошибку в проекте или у вас есть предложения по улучшению, пожалуйста, создайте новый Issue в репозитории проекта. Опишите проблему или предложение подробно, чтобы мы могли понять и рассмотреть их.

Еще одним способом помочь проекту является тестирование. Вы можете протестировать новые функции, исправления ошибок и сообщить о найденных проблемах.

Последний релиз: https://github.com/pimnik98/SayoriOS/releases

### Документирование
### <a id="techwriters">Документирование</a>

Приветствуется вклад Technical Writers!

### Пиар
### <a id="adv">Пиар</a>

Если вы готовы сделать обзор ОС или написать о ней где-нибудь, пожалуйста свяжитесь с координационной группой проекта.

## Правовая информаиция
## <a id="legalinfo">Правовая информаиция<a/>

### Отказ от отвественности
### <a id="denialofresponsibility">Отказ от отвественности</a>

SayoriOS это не дистрибутив Linux, это совершенно-новый проект который не имеет за собой компании или организации которая могла бы дать гарантий.

Expand All @@ -185,7 +183,7 @@ SayoriOS это не дистрибутив Linux, это совершенно-

Запуск ядра возможен на реальном оборудовании, были тесты и на некоторых устройствах оно реально запустилось, хоть и с ограничениями

## Контрибьюторы
## <a id="contributors">Контрибьюторы</a>

* [Никита Пиминов](https://github.com/pimnik98) (Создатель SayoriOS)
* [Андреян Павленко](https://github.com/NDRAEY)
Expand Down

0 comments on commit fe834b0

Please sign in to comment.