Skip to content

Latest commit

 

History

History
74 lines (53 loc) · 4.98 KB

CONTRIBUTING.md

File metadata and controls

74 lines (53 loc) · 4.98 KB

Кратко

#### Стандартный флоу

Fork -> edit -> pull request!

Ленивый флоу

Напишите, скиньте, нарисуйте ваши предложения мне вконтактик

Подробней

Где я нахожусь?

На гитхабе - большом таком веб-приложении для управления репозиториями. Репозиторий, грубо говоря - это директория с историей содержимого, которая позволяет откатывать изменения и добавлять новые, сохраняя слепок старой версии. В этом контексте важны две вещи: а) изменения довольно легко объединять (если читающий это не поленится и погуглит git и git fork, то и сам сможет слать мне запросы на объединение) и б) гитхаб использует свою версию языка разметки Markdown, которая частично есть и в этом самом вконтактике, и которая, похоже, скоро станет стандартом везде.

Как всем этим пользоваться?

В основном - смотреть через интернет. Репозиторий содержит в себе простые текстовые файлы, которые отформатированы согласно языку Markdown, и гитхаб сам превратит их в читаемый вид, если перейти на страницу того или иного файла (вот прямо этот файл, например), через некоторое время я допишу тулзу, которая будет собирать это все в красивые html-файлики, которые откроются любым браузером на любом устройстве.

Я все равно скачал файлы, почему у меня все в одну строку?

Потому что кое-чей дед пользуется виндой, вот почему. В линуксе и маке символ перевода строки - \n, на маке прошлого века - \r, на винде - \r\n, поэтому там, где я забуду их сконвертировать, все будет в одну строку. Проще всего открыть это дело редактором, который такие вещи понимает. Вики для самых умных.

Что мне сделать, чтобы внести свою лепту?

Идеальный вариант - если ты, дорчитатель, прочитаешь про устройство git и github, синтаксис markdown и будешь слать мне пулреквесты. Если ты криптоанархист и воюешь против прогресса, то просто пришли мне изменения любым способом, я даже отформатирую их сам.

Сколько просуществует этот репозитарий?

Столько, сколько гитхаб предоставляет бесплатные публичные репозитарии (скорее всего - всегда).

Мне нужно захерачить мегаформулу, как это сделать?

  1. Пройти на http://www.sciweavers.org/free-online-latex-equation-editor
  2. Зафигачить формулу
  3. Скопировать снизу из embed ссылку под ключом "twitter, google docs"
  4. Вставить ее в документ согласно синтаксису Markdown: ![текст при наведении](ссылка с sciweavers.org)

Хорошо, а что с обычной картинкой?

  1. Картинка должна тем или иным путем оказаться в img
  2. После чего на нее надо сослаться аналогичным образом: ![текст при наведении](../img/some-image.jpg)
  3. На самом деле я не уверен, что это сработает.

Я не хочу тебе ничем помогать, запили мне ответы, я буду лежать на диване и поедать их глазами

Я, в свою очередь, не буду поддерживать эту репу, если внезапно окажется, что я пишу ответы в одиночку ¯\_(ツ)_/¯