Coder Social home page Coder Social logo

coool / cloverbootloader-documentation Goto Github PK

View Code? Open in Web Editor NEW

This project forked from drovosek01/cloverbootloader-documentation

0.0 0.0 0.0 125 KB

Translation of the entire book "Clover of hacky color" from PDF to Markdown markup and into English

cloverbootloader-documentation's Introduction

Документация по загрузчику Clover

Языки

ENGLISH (coming soon)

Я планирую заняться переводом на английский язык, как только будет оформлена основная часть документации на русском языке.

Готовое

Описание параметров config.plist - начал оформлять

Предисловие

Когда я начал знакомится с загрузчиком Opencore, то начал искать официальную документацию этого загрузчика и, на мое удивление, нашел ее прямо в репозитории загрузчика в формате TeX и в формате PDF, а так же есть вроде как неофициальная веб версия этой документация на сайте dortania.

Меня очень порадовала такое количество полезной информации по настройке загрузчика от официальных разработчиков. Есть сам описание всех параметров файла конфигурации загрузчика, есть описание спорных моментов и даже файл, в котором показана разница в документах за предыдущую и настоящую версии загрузчика. А наличие веб версии (хоть и не официальной), позволяет поисковым системам проиндексировать эту документацию и, если кто-то будет искать информацию по определенному параметру в файле config.plist, то поисковые системы могут показать, что эта информация есть в официальной документации.

К сожалению, в отличие от загрузчика Opencore, у загрузчика Clover дела с документацией немного хуже. В настоящий момент информация по настройке загрузчика Clover распространяется в виде книги в формате PDF, под названием "Кловер цвета хаки" (или "Клевер цвета хаки"). Эта книга пишется и публикуется разработчиком загрузчика Clover в разделе релизов на странице его репозитория. Публикуется она не с каждым релизом, а только в том случае, если в ней произошли какие-то изменения.

Цели

Дело в том, что "Кловер цвета хаки" это, на мой взгляд, все же больше книга, чем документация. Без сомнения она безгранично полезна для настройки загрузчика Clover, но написана она во многих местах очень неформальным языком из-за чего автоматический перевод этой книги на английский язык дает некорректные результаты. Так же (возможно это звучит как придирка) в ней нет единого стиля оформления в плане отступов и описания пунктов и часто трудно понять к какому пункту относиться написанный текст.

Здесь, я бы хотел создать документацию по загрузчику Clover, в которой бы, как минимум были бы описаны все пункты файла config.plist для загрузчика Clover, их возможные значения и значения по-умолчанию, может быть примеры кода и другое.

В общем я хочу сделать документацию для загрузчика Clover наподобие такой, как она выглядит у загрузчика Opencore.

Источники

Наверное не все знают, но раньше код загрузчика Clover и его релизы находились в сервисе SourceForge и, наверное, начиная с ревизии 5071 загрузчик Clover начал официально публиковаться на GitHub (потому что ревизия 5071 первая в списке релизов на Github странице репозитория загрузчика) и страница загрузчика Clover на SourceForge теперь заброшена. Дело в том, что на этой странице есть раздел "Wiki" в котором как-раз таки описывались параметры файла config.plist и как раз на английском языке, но та документация давно перестала обновляться. Так же некоторые пункты файла конфигурации описываются на странице на форуме insanelymac со списком изменений в новых версиях загрузчика Clover.

В общем вот список сайтов, с которых я буду брать информацию при составлении документации:

Кстати, раньше был сайт-вики по настройке config.plist для загрузчика Clover, который, на мой взгляд, полностью повторял информацию из раздела Wiki на странице Sourceforge. Этот сайт почему-то закрылся и его адрес https://clover-wiki.zetam.org/

cloverbootloader-documentation's People

Contributors

drovosek01 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.