|
   |
| Модератор форума: tupi857 |
| Форум » Видоизменение » Технологии » Написание правильного ReadMe |
| Написание правильного ReadMe |
|
# 110:52 04/06/2019
Когда вы собираетесь выпустить свой мод, важно, чтобы вы всегда включали хорошо написанный и подробный ReadMe. Это поможет тем, кто не знает, как установить мод, и может решить многие вопросы с теми, кто скачал ваш мод.
Так что же должен включать в себя правильный ReadMe? Сначала вы начнете с названия вашего мода, скажем, мы создали мод XYZ. Мы также должны включить версию, чтобы люди тоже могли видеть, какую версию вашего файла они скачали. Даже если вы выпускаете только одну версию и не планируете выпускать больше версий в будущем, всегда разумно указывать версию 1.0. Также укажите свой ник, чтобы они могли видеть, кто создал мод. Это то, что мы получили так далеко: Код XYZ V1.0 ReadMe by Me ------------------------------------------- ----- (добавление делителей всегда хорошо) После вашего заголовка всегда приятно поблагодарить людей за загрузку вашего мода и надеяться, что им понравится ваш мод, bladi bladi bla. Несмотря на то, что люди скачали ваш мод из-за описания, которое они видели из него, также поместите описание в ваш ReadMe. Что приводит нас к этому: Код XYZ V1.0 ReadMe by Me ------------------------------------------- ----- Спасибо, бла бла, наслаждайтесь бла бла. Особенности этого мода: 1.Lorum Ipse 2.Lorum Ipse Теперь, когда у нас есть открытие ReadMe, пришло время добраться до его сути. Всегда указывайте, как установить, чтобы файл «Xa» переходил в «A», «Xb» переходил в «B» и т. Д. Также не забудьте добавить, что речь идет об установочной папке, а не о том, что в «Моих» Документы. Также может быть хорошей идеей заключить имена файлов и папок в «», чтобы прояснить, как называется файл / папка. И хотя установка мода важна, также добавьте, как удалить мод! Большинство из раз это просто удалит измененные файлы, но добавьте это тоже. Так что теперь мы добрались до этого: Код XYZ V1.0 ReadMe by Me ------------------------------------------- ----- Спасибо, бла бла, наслаждайтесь бла бла. Особенности этого мода: 1.Lorum Ipse 2.Lorum Ipse Руководство по установке: Поместите «Xa» в папку «A» и «Xb» в папку «B». Когда вы это сделаете, переместите все файлы "* .c" в папку "C". Руководство по удалению: Чтобы удалить, просто удалите «Xa» из папки «A», «Xb» из «B» и «* .c» из папки «C», и все готово! Сейчас мы собрали базовый ReadMe, но есть некоторые вещи, которые также стоит добавить. Такие вещи, как возможные проблемы, с которыми могут столкнуться пользователи, и способы их решения, или, возможно, известные ошибки, которые вам еще не удалось исправить. И как последнее, запишите свой адрес электронной почты, сайт и / или ветку форума, чтобы люди могли связаться с вами, когда у них возникнут проблемы / предложения и т. Д. И в самом конце, скажите что-то вроде "Наслаждайтесь этим модом!" а потом твой ник. Итак, хорошо написанный ReadMe должен выглядеть примерно так: Код XYZ V1.0 ReadMe by Me ------------------------------------------- ----- Спасибо, бла бла, наслаждайтесь бла бла. Особенности этого мода: 1.Lorum Ipse 2.Lorum Ipse Руководство по установке: Поместите «Xa» в папку «A» и «Xb» в папку «B». Когда вы это сделаете, переместите все файлы "* .c" в папку "C". Руководство по удалению: Чтобы удалить, просто удалите «Xa» из папки «A», «Xb» из «B» и «* .c» из папки «C», и все готово! Возможные ошибки: Проблема Решение A Если у вас есть какие-либо вопросы, предложения и т. Д., Пожалуйста, свяжитесь со мной по адресу me@internet.com , перейдите на мой сайт http://me.internet.com или оставьте сообщение в моей ветке форума, расположенной по адресу aoe3h.heavengames.com/ XYZ. Наслаждайтесь модом! мне PS: Я бы порекомендовал вам сделать свой ReadMe с помощью Блокнота, так как каждый может открыть .txt файлы. LOVEAOE
|
| |||
| |||
