diff --git a/README.md b/README.md index 2cff14d..f06de69 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,125 @@ -# Описание проекта -## Приложение "Одуванчик" -### Стэк технологии React, Python ..... -#### Команда из 7 человек +*Скопировал в данный файл свою инструкцию по работе с Git (с прошлой домашней работы) и добавил информацию по новым командам (для работы с удаленными репозиториями)* +**Upd 2:** -**4510_Group** +*Добавил пошаговую инструкцию по работе с удаленным репозиторием:* + +1. Делаем fork интересуюшего нас проекта; + +2. Командой (git clone) создаем файл проекта на нашем локальном репозитории; + +3. Создаем новую ветку (git checkout -b название ветки) для внесения изменений в проект; + +4. Вносим изменения тоько в этой ветке; + +5. Отправляем эти изменения на свой аккаут (git push); + +6. В окне GitHub появляется возможность отправить pull request + +# **Инструкция по работе с Git** + +## Основные команды Git + +* git init - инициализация локального репозитория; + +* git status - получение информации от git о его текущем состоянии; + +* git add - добавление файла или файлов к следующему коммиту; + +* git commit -m "massage" - создание коммита; + +* git log - вывод на экран истории коммитов с их хеш-кодами; + +* git checkout - переход от одного коммита к другому; + +* git checkout master(main) - вернутся к актульному состоянию и продолжить работу; + +* git diff - увидеть разницу между текущим файлом и закоммиченным файлом; + +* git clone - клонирование внешнего репозитория на локальный ПК; + +* git pull - получение изменений и слияние с локальной версией; + +* git push - отправляет локальную версию репозитория на внешний; + +* git remote set-url origin - сбрасывает линк с предыдущего репозитория. Необходимо при перепривязке нового адреса на локальном ПК. + +*** +*** + +# **Инструкция по синтаксису Markdown** + +## Параграфы и разрывы строк + +*Чтобы поделить текст на параграфы, между ними нужно оставить пустую строку.* + +## Заголовки + +*В синтаксисе Markdown есть шесть уровней заголовков: от H1 (самого большого) до H6 (самого маленького). Для их выделения используют решётки #, при этом есть несколько тонкостей:* + +* Решётки можно ставить как перед заголовком, так и с двух сторон от него (на уровень заголовка влияют только те #, которые находятся перед ним); +количество решёток соответствует уровню +* Заголовка: одна для первого уровня, две для второго и так далее; +* Между решёткой и текстом ставится пробел. + +## Выделение текста + +*Чтобы изменить начертание текста, нужно выделить его с двух сторон спецсимволами следующим образом: <спецсимвол>текст<спецсимвол>.* + +*Курсив* - Для выделения текста курсивом нужно использовать одну звёздочку * или нижнее подчёркивание _. + +__Жирный__ - Для выделения текста жирным нужно использовать две звёздочки ** или два нижних подчёркивания __. + +***Жирный курсив*** - Для выделения текста сразу обоими стилями нужно использовать три звёздочки *** или три нижних подчёркивания ___. + +~~Зачёркнутый~~ - Чтобы зачеркнуть текст, нужно использовать две тильды ~~. + +Подчёркнутый - В синтаксисе Markdown нет встроенного способа подчеркнуть текст. Но если ваш редактор поддерживает HTML, то можно использовать теги: Текст + +## Разделители + +*Чтобы оформить горизонтальный разделитель, нужно поставить три или больше специальных символа: звёздочки* *, дефиса - или нижних подчёркивания _. Они должны находиться на отдельной строке, и между ними можно ставить любое количество пробелов и табуляций.* + +Пример +*** +Пример + +## Цитаты + +*Чтобы параграф отобразился как цитата, нужно поставить перед ним закрывающую угловую скобку >* + +>Пример цитаты + +## Списки + +*В синтаксисе Markdown есть несколько видов списков. Для их оформления перед каждым пунктом нужно поставить подходящий тег и отделить его от текста пробелом.* + +### Нумерованные + +*Для создания нумерованного списка перед пунктами нужно поставить число с точкой.* + +### Ненумерованные + +*Для создания ненумерованного списка нужно поставить перед каждым пунктом звёздочку *, дефис - или плюс +.* + +## Вложенные + +*Чтобы создать вложенный список, нужно поставить перед его пунктами табуляцию или несколько пробелов. В Markdown одна табуляция соответствует четырём пробелам.* + +1. Пример + 1. Подпункт примера + 1. Подпункт пример 2 + +## Ссылки + +*Чтобы оформить ссылкой часть текста, используется такой синтаксис: [текст](ссылка). Можно сделать всплывающую подсказку при наведении курсора. Для этого в круглых скобках после ссылки нужно поставить пробел и написать текст подсказки в кавычках.* + +[GeekBrains](https://gb.ru/ "Лучший сайт по изучению программирования!") + +## Картинки + +*Изображения в Markdown оформляются по принципу, схожему с принципом оформления ссылкок, только перед квадратными скобками нужно поставить восклицательный знак: ![текст](путь к изображению). Здесь также можно сделать всплывающую подсказку.* + +![GeekBrains](https://expertali.ru/image/page/geekbrains.png) + +Спасибо! :)