4.6 KiB
Как принять участие в создании книги?
Благодарим за ваше желание помочь! Есть множество способов это сделать:
- Перевод
- Доработка глоссария
- Редактирование
- Выкладывание ваших шейдеров в общий доступ с помощью онлайн-редактора
Перевод
Книга написана на языке разметки Markdown, поэтому с её текстом очень легко работать.
-
Для начала перейдите в репозиторий по адресу
github.com/patriciogonzalezvivo/thebookofshaders
. Осмотрите файлы и каталоги в нём. Легко заметить, что контент находится в файлахREADME.md
и других файлах, названных заглавными буквами:TITLE.md
,SUMMARY.md
и так далее. Так же вы заметите, что переводы находятся в файлах, имена которых заканчиваются двумя буквами, указывающими на язык перевода, например:README-jp.md
,README-es.md
и прочие. -
Форкните репозиторий и склонируйте его к себе на компьютер.
-
Продублируйте содержимое файлов, которые хотите перевести. Не забудьте добавить двухбуквенный код языка, на который переводите.
-
Переведите контент (см. Примечания о переводе).
-
Протестируйте (см. Тестирование).
-
Сделайте push в ваш собственный форк и затем создайте пулл-реквест в основной репозиторий.
Примечания о переводе
Не удаляйте и не изменяйте встроенные примеры, которые выглядят примерно так:
<div class="codeAndCanvas" data="grid-making.frag"></div>
или так:
<div class="simpleFunction" data="y = mod(x,2.0);"></div>
Тестирование
Запустите локальный PHP-сервер в папке вашего локального репозитория:
php -S localhost:8000
Теперь в браузере перейдите по адресу localhost:8000
, зайдите на переводимую страницу и добавьте в конец адреса строку ?lan=xx
, где xx
- код языка, на который переводите.
Например, если вы переводите главу 03
на французский, значит вы работали над файлом 03/README-fr.md
, который можно протестировать по адресу http://localhost:8000/03/?lan=fr
.
Доработка глоссария
Этот раздел находится в разработке. Мы рады узнать ваше мнение о том, как сделать из него что-то полезное. Пишите нам на @bookofshaders.
Редактирование
Все мы люди. Если вы видите ошибку - сообщите о ней и сделайте пулл-реквест, или откройте issue на гитхабе. Спасибо!
Выкладывайте ваши шейдеры
Вы увидите множество ссылок на онлайн-редактор и написанный в нём код, встроенный в книгу. Если вы написали что-то стоящее, нажмите «Export» (или иконку ⇪
) и скопируйте ссылку на код. Отправьте её на @bookofshaders или @kyndinfo. Мы будем рады видеть ваш код и добавить его в галерею примеров.