Как выложить НИР/ВКР в git
Основные шаги¶
Следующие шаги помогут вам выложить вашу НИР/ВКР в git репозитарий.
- Регистрация на git-хостинге, установка git
- Создание репозитария
- Выкладывание работы
Регистрация на git-хостинге¶
Если у вас нет аккаунта: создайте аккаунт на любом популярном хостинге для git-репозитариев. Очевидный первый выбор: GitHub. Альтернативы: gitlab, bitbucket.
Установка и настройка git¶
Базовый подход¶
Если у вас нет git на компьютере:
-
Установите git. Если у вас Windows, то вам достаточно скачать и запустить установщик (и сделать logout – login). Пользователям Linux рекомендуется ставить git из пакетного менеджера вашего дистрибутива (пример для Ubuntu/Debian: sudo apt-get install git), для MacOS настоятельно рекомендуется установить Homebrew и сделать brew install git. После этих действий команда git должна быть доступна из командной строки (в случае с Windows её можно запустить и из Git Bash – найдите его в меню “Пуск”). Запустите git --version
в командной строке (Win + R -> cmd -> OK) и убедитесь, что она доступна, и вы видите версию Git. ВАЖНО: обратите внимание на то, какой редактор предлагает выбрать git при установке. Часто им становится vi/vim, который обладает абсолютно контринтуитивным интерфейсом для новичков. Поменяйте редактор на более удобный вам (например, VSCode, Настройка VSCode как редактора для git), если вы не на “ты” с vim, или обратитесь к учебнику. 2. (Если git только установлен). Проведите начальную настройку git, выполнив следующие команды: git config --global user.name "<Ваше имя (латиницей)>" git config --global user.email "<Ваш e-mail>"
Упрощенный подход¶
Установите GitHub Desktop – упрощенный интерфейс для работы с git. Он же доустановит и сам git, если его нет. Запустите его и залогиньтесь внутри него в ваш аккаунт на GitHub.
Создание репозитория¶
Общие замечания¶
- Дайте репозиторию разумное имя (например, имя подобное “zvonarev_nir_5sem” устроит всех). Репозиторий должен быть публичным.
- ВАЖНО. Используйте .gitignore для TeX. В секции “Add .gitignore” выберите TeX (LaTeX и пр., если такие варианты есть) – это нужно, чтобы в git не попали временные файлы, возникающие при сборке вашей работы с помощью LaTeX.
Базовый подход¶
- Создайте новый репозитарий на хостинге. Ссылка для github: New repository. Дайте ему разумное имя, не забудьте про .gitignore, и сделайте его public.
-
Склонируйте ваш созданный репозитарий на компьютер. Для этого надо зайти на страницу только что созданного репозитария, и найти там кнопку Code (Clone и проч.). Важно: выберите вариант Clone по HTTPS, если вы не настраивали ssh-ключи в git (это нетривиальный шаг, если вы только что установили git, наверное, вы не делали этого). Сервис покажет вам https-адрес вашего репозитария, например, https://github.com/nikita/zvonarev_nir_5sem.git , скопируйте его в буфер обмена. Перейдите с помощью bash/cmd в любой удобный вам каталог (например, домашний для вашего пользователя, но если пользователь у вас назван кириллицей или содержит пробелы, то лучше создать каталог наподобие “repos” в корне диска и работать с ним) и выполните git clone
например, git clone https://github.com/nikita/zvonarev_nir_5sem.git. В Windows вы можете вставить адрес, нажав правой кнопкой мыши на заголовок окна с git/cmd, и выбрать соответствующий пункт меню. После этого git запросит у вас имя/пароль от вашего git-аккаунта, и создаст копию репозитария в каталоге с именем репозитария (в моём случае – zvonarev_nir_5sem). Перейдите в этот каталог с помощью cmd/bash.
Упрощенный подход¶
Используйте приложение GitHub Desktop, комбинацию клавиш Ctrl + N. Не забывайте про имя репозитория и .gitignore.
Выкладывание работы¶
Базовый подход¶
- Добавьте файлы вашей НИР/ВКР в репозитарий (то есть, в том каталоге, в которую вы только что перешли в консоли) с помощью копирования.
-
Вернитесь в cmd/bash и добавьте файлы с помощью команды git add *
После этого вы сможете посмотреть, что было добавлено в стадию для создания коммита (staging), с помощью команды git status. Список должен быть непустым. 3. Создайте коммит с вашими добавлениями с помощью команды git commit -m "<имя коммита>"
например, git commit -m “Initial file upload”. Если всё прошло ОК, то вы должны получить сообщение с хэшом и именем коммита. 4. Сделайте push, чтобы выложить информацию на git-хостинг. Для этого вам нужна следующая команда: git push 5. Проверьте, что все необходимые файлы (включая картинки) теперь лежат на git-хостинге. Если что-то было забыто, то эти файлы можно добавить дополнительными коммитами и push-ами. 6. Для синхронизации локального репозитария с репозитарием на хостинге используйте команду git pull. 7. Для подробной справки по git и как им в целом пользоваться читайте Git book.
Упрощенный подход¶
- Добавьте файлы в каталог репозитария с помощью копирования.
- Посмотрите изменения в GitHub Desktop в графическом режиме, впишите имя коммита (поле ввода рядом с вашей аватаркой).
- Если всё устраивает, нажмите на кнопку “Commit to main” чтобы создать коммит.
- Для выкладывания изменений нажмите кнопку “push origin” в GUI.
- Дополнительную справку по GitHub Desktop ищите в GitHub Desktop Documentation.
Удачи!