Поиск…


замечания

В этом разделе представлен обзор того, что такое github, и почему разработчик может захотеть его использовать.

Следует также упомянуть о любых крупных предметах в рамках github и ссылки на связанные темы. Поскольку документация для github является новой, вам может потребоваться создать начальные версии этих связанных тем.

Установка или настройка

GitHub - огромная коллекция репозиториев Git. Другими словами, вы можете думать о GitHub как о наборе многих проектов!

Создание учетной записи

  • Посетите главную страницу GitHub в этом
  • Выберите имя пользователя, введите свой адрес электронной почты и выберите безопасный пароль, и вы готовы к работе!

Полезные инструменты

Для начинающих Git / GitHub понимание того, как работает управление версиями, может сначала ввести в заблуждение. Существует версия GUI GitHub, которую вы можете скачать и использовать. GitHub Desktop - это тот инструмент.

Создание первого хранилища

Вы можете думать о репозитории как о проекте. Вы можете создать репозиторий онлайн или офлайн. Выполните следующие действия:

онлайн

  1. Сначала войдите в систему и перейдите в свой профиль.
  2. Перейдите на вкладку «Хранилища» в верхней части страницы.
  3. Нажмите зеленую кнопку «Создать», и вы готовы гулнуть!

Не в сети

  1. Загрузите и установите git (выберите операционную систему, в которой вы работаете)
  2. После загрузки и установки вы можете использовать инструмент командной строки или загрузить клиент GUI.
  3. После установки создайте учетную запись на github
  4. В правом верхнем углу нажмите + и выберите либо создание нового репозитория, либо импорт существующего.
  5. Если вы выберете новую, введите имя репозитория и выберите либо общедоступную, либо приватную.
  6. Нажмите: Создать репозиторий

NB Частные репозитории недоступны для бесплатных пользователей.

Файл README

Если ваш проект не имеет README.md, GitHub может анализировать README.rdoc для отображения деталей. Если он есть, он будет использовать README.md, молча игнорируя rdoc.


Файл README может включать-


Название Проекта

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

Скачать

Ссылка на исполняемый файл (исполняемый файл или миниатюрный или установочный файл). Также могут быть ссылки на предыдущие версии.

Монтаж

Как ваша работа может быть использована. Он может включать предварительные условия, настройки, сторонние библиотеки, использование, предостережения и т. Д.

демонстрация

Он может включать в себя образец кода, файл gif, ссылку на видео или даже скриншоты.

Авторы

Имена авторов, контактная информация и т. Д.

Подтверждения

Список людей или сообщества помог и вдохновлен во всем проекте

Содействие

Инструкции по внесению вклада (т. Е. Добавить функцию, сообщить об ошибке, отправить патч) в проект. Может также содержать ссылку на документацию.

Лицензия

Дайте краткое введение по вашей лицензии. Вы также можете указать ссылку на сайт лицензии.

ЛИЦЕНЗИОННЫЙ файл

GitHub помогает вам быстро добавить лицензию в ваш репозиторий, в качестве альтернативы для добавления собственного файла text / markdown.

  1. В вашем репозитории нажмите «Создать новый файл»,

    шаг 1

  2. На следующей странице:

    1. Введите имя файла LICENSE.md или LICENSE.txt качестве имени файла нового файла.
    2. Хотите использовать новый шаблон? появится диалоговое окно.

    шаг 2

  3. Выберите предпочтительную лицензию.

    шаг 3

  4. Лицензию, которую вы можете увидеть в репозитории:

    шаг 4

Из вопросов и ответов - Как добавить лицензию на существующий проект Github

GitHub Flavored Markdown

GitHub расширяет синтаксис Markdown для предоставления новых полезных функций.

заголовок

# Header1
## Header2
### Header3
#### Header4
##### Header5
###### Header6
H1
===
H2
---

заголовок

акцент

*Italic1* _Italic2_
**Bold1** __Bold2__
***Bold_Italic***
~~Strikethrough~~

акцент

Горизонтальная линия

---
***
___

горизонтальная линия

Список

unordered list:

* item-1
  * sub-item-1
  * sub-item-2
- item-2
  - sub-item-3
  - sub-item-4
+ item-3
  + sub-item-5
  + sub-item-6


ordered list:

1. item-1
  1. sub-item-1
  2. sub-item-2
2. item-2
  1. sub-item-3
  2. sub-item-4
3. item-3

список

Таблица

Table Header-1 | Table Header-2 | Table Header-3
:--- | :---: | ---:
Table Data-1 | Table Data-2 | Table Data-3
TD-4 | Td-5 | TD-6
Table Data-7 | Table Data-8 | Table Data-9

Таблица

Код

inline code- `int i=0`

block code-
``` C
for(int i=0; i<10; i++){
    printf("Hallow World! \n");
}
```

код

котировка

> Stay hungry; stay foolish.
>> Quality is better than quantity.
>>> Life is not fair; get used to it.

котировка

Ссылка на сайт

https://github.com    
[GitHub](https://github.com)    
[GitHub](https://github.com "github website")    
[GitHub][1]    

[1]: https://github.com

Ссылка на сайт

Образ

![GitHub Logo](https://assets-cdn.github.com/images/icons/emoji/octocat.png "GitHub")

образ

Списки задач

- [x] completed item
- [ ] incomplete item

список заданий

Emoji

:octocat: :+1: :book: :ghost: :bulb: :imp:

Для всех посетителей GitHub emojies - Emoji Cheat Sheet .

Ссылки SHA

Любая ссылка на хэш SHA1 коммита будет преобразована в ссылку на сам commit в GitHub:

e7909ea4fbb162db3f7f543d43c30684a3fb745f

sha1

Вызов запроса и выдачи

Любая ссылка на запрос на перенос или проблему будет автоматически связана с этим запросом на перенос или проблемой.

Это можно сделать, поставив # перед номером вопроса / Pull Request.



Modified text is an extract of the original Stack Overflow Documentation
Лицензировано согласно CC BY-SA 3.0
Не связан с Stack Overflow