README.md в репозиториях -- как офомляеть описания

Многие репозитории в частности на гитхаб используют файлы типа README.md, куда обычно размещают документацию (или краткую её версию).

Для форматирования текста в ней часто используют разметку маркдаун.

git Репозиторий -- что это

Репозиторий -- это хранилище данных, в общем случае в нём содержатся файлы и папки проекта + сведения о том, как именно и какими шагами изменялись эти файлы и папки (хранением этой истории. работой с ней в частности занимается Git).

Репозиторий git бывает локальным и/или удаленным.

Локальный репозиторий — это поддиректория .git, создается (в пустом виде) командой

git init

и (в непустом виде с немедленным копированием содержимого родительского удаленного репозитория и простановкой ссылки на родителя) командой

composer Что такое пакет, зависимость

Термины

  • Пакет -- это то, чем оперирует композер (файл/директория с файлами или логически объединеннная их группа), когда подтягивает зависимости какого-либо проекта (приложения) или другого пакета (зависимости могут быть иерархическими).

    Всякий пакет в конечно итоге это какие-то файлы, которые можно загрузить в свое web-приложение с помощью композера. На практике часто это php-классы, находящиеся в каком-либо пространстве имён.

Как редактировать отдельные модули, которые подтянуты с помощью composer, чтобы изменения тоже были под управлением версий (Git)

Пусть есть ситуация:

  • Вы разрабатываете проект, в котором с помощью composer подтянут ряд библиотек.
  • Как известно, эти библиотеки загружаются в папку vendor/, изменений которой системой версии обычно игнорируются (так настраивают).

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

composer.lock -- Зачем он нужен. Когда добавлять его в .gitignore (хранить в репозитории) и почему

Предназначение файла composer.lock - записать в него непосредственно те версии, которые были установлены (их точные идентификаторы, а не просто допустимые диапазоны, которые можно как в composer.json) -скачены при установке или обновлении пакетов.

Добавление файла composer.lock в репозиторий (под контроль версий)

Если добавить его в репозиторий (что делают не всегда), то команда

composer install

будет все равно устанавливать версии не выше тех, что записаны первый раз в composer.lock

composer -- Загрузка зависимостей (пакетов) с github. Пример composer.json

Что должно быть в вашем проекте, который использует пакет:

В вашем проекте должен лежать composer.json, который как минимум указывает зависимости вашего пакета (имя и иные сведения не нужны -- если сам проект не является пакетом):

composer Откуда берёт, качает пакеты -- как ищет пакет (repositories)

Откуда

Вообще основным (стандартным) источником пакетов для composer является сайт https://packagist.org/ куда все "серёзные" пакеты и загружаются.

Как начать изучение HTML и CSS

Можно на сайте HTML Academy. Это онлайн-курсы: информативно и занимательно. Достаточно большой объём знаний можно получить бесплатно.

  1. Регистрируемся на сайте
  2. Начинаем с курса "Знакомство"
  3. Далее по мере выполнения, изучаем более сложные темы -- все первые уроки бесплатны, ими для начала можно и ограничиться.

На сайте очень удобный интерфейс. Задания описаны понятным языком, не заблудитесь.

Pages

Subscribe to fkn+antitotal RSS