注目キーワード
  1. Photoshop
  2. Python
  3. Raspberry Pi
  4. Arduino

GitHub リポジトリの作り方~初心者向け

ここでは計15枚の画像を用いて、初心者向けに「GitHub」でリポジトリを作る方法を紹介します。

 

この記事を読むことで

GitHubでリポジトリを作る流れ

README.mdの書き方と例文

画像の読み込み

プログラムファイルの読み込み

を知ることができます。

 

GitHub初心者向けのリポジトリ登録方法が図解で解説されているものが少なかったので、まとめることにしました。

Webブラウザ版GitHubからリポジトリ登録するときに役立てて頂ければ幸いです。

 

それでは早速、始めていきましょう!

※ コマンドを使う方法は紹介しておらず、ブラウザ版での操作方法をメインに紹介しています。

 

初心者向けGitHubでのリポジトリの作り方

GitHubでのリポジトリ作成方法を4つのステップに分けて、紹介していきます。

知っている箇所は読み飛ばして頂いて構いません。

 

また、GitHubでのユーザー登録は既に済んでいるものとして進めますので、ご容赦ください。

 

GitHubでリポジトリを作る

マイページにアクセスしたら、右上の

+ > New repository

を選択しましょう。

 

git_repository_01

 

新しく作成するリポジトリの詳細を記入する画面に切り替わるので、各項目ごとに必要事項を記入&選択していきます。

 

リポジトリ作成時の用語Repository name:作成するリポジトリの名前Description:リポジトリの要約・説明

Public/Private:一般公開/プライベートでの公開

Add a README file:READMEファイルを追加

Add .gitignore:無視するファイル等の指定を追加

Choose a license:ライセンスの選択

 

git_repository_02

 

ここでは、上図のように必要事項を記入し

Add a README file
Choose a license:MIT License

を選択&追加しました。

 

gitignoreの追加は、無視させたいファイルやディレクトリがないのでチェックを外しています。

これらの記入が終わったら

Create repository

をクリックして、リポジトリを新規作成します。

 

GitHubのREADMEを編集する

リポジトリを新規作成したら、README.mdファイルを編集し、リポジトリの説明を記述していきます。

README.md欄の右側にある鉛筆マークをクリックしましょう。

 

git_repository_03

するとREADME編集画面になるので、下記の記述例を参考にして編集を行います。

 

README.mdの記述例

# RGBLED-StepperMotor-Arduino
Multi processing of RGB fullcolor LED and Stepper Motor by Arduino

Promotion Video :[ URLリンクテキスト ]( URL )

## Requirements
- Windows10
  - Arduino IDE
  - [TimedAction.h]( URL )
- Arduino 
    - Arduino Nano etc
- Electronic components
    - DRV8835 Stepper & DC motor module
    - ST-42BYH1004
  - 5mm Motor Hub for shaft
  - SI-8050S DC5V3A Switching power supply kit
  - battery 7~12V
  - volume (use two)
  - jumper wire 
- 3D Parts
  - 3D model case etc

## Usage
By running the program on Arduino, change the blinking LED and the rotation speed of the motor depending on the volume value.

## Reference
- [参考サイト名など](参考サイトのURL)

## License
[MIT](https://github.com/ユーザー名/リポジトリ名/blob/main/LICENSE)

 

上記のうち

 

READMEで使う表現# :h1 (ヘッダー1)

##:h2 (ヘッダー2)

[URLリンクのテキスト名](URL):テキストにURLをハイパーリンク

– :箇条書き(インデントによって箇条書きのフォントが変わる)

を表すので、これらは最低限覚えておきましょう。

 

また、MITライセンスのURLは

[MIT](https://github.com/ユーザー名/リポジトリ名/blob/main/LICENSE)

とユーザー名、リポジトリ名だけ間違えないようにリンクを記載すると、MITライセンスページへ飛ばすことができます。

 

一通り、README.mdファイルが書けたら

Preview changes

をクリックして、記述したREADMEファイルがどのように見えるかを 確認します。

 

git_repository_03-5

 

確認して問題なさそうなら、ページ下部より「Commit changes」をクリックしてREADMEファイルの編集を一旦終了します。

 

git_repository_04

 

コミットすると、README.mdファイルの設定が反映されているのが確認できますね。

 

git_repository_05

 

GitHubに画像を読み込む

リポジトリ内に画像を読み込む方法を紹介します。

 

画面上部にある

Issues > New issue

とボタンを選択し

 

git_repository_06

 

下図のエリアに、リポジトリ内に挿入したい画像をドラッグ&ドロップします。

 

git_repository_07

ドラッグ&ドロップすると

 

git_repository_08

 

![ファイル名](URL .拡張子)

という並び順でURLが生成されます。

 

この生成された文字列全てをコピーして、先ほどのREADME編集ページにペーストすれば簡単に画像を挿入することができます。

 

2つ以上画像をドラッグ&ドロップしてみると

git_repository_09

と文字列が増えていることが確認できますね。

 

実際に、README.mdファイルに生成した文字列をペーストしてみると

git_repository_10

と画像が表示されていることが確認できます。

 

GitHubにプログラムファイルを追加する

最後に、GitHubにプログラムファイルを追加する方法を紹介します。

 

画面内の

Add file ▼ > Upload files

を選択します。

 

git_repository_11

 

すると「Drag files here to add them to your repository」と表示されるので、この部分にリポジトリ登録したいプログラムファイルをドラッグ&ドロップします。

 

git_repository_12

 

ドラッグ&ドロップでファイルを読み込むと

 

git_repository_13

 

と表示されるので、「Commit changes」をクリックします。

 

git_repository_14

 

このようにプログラムファイルが追加されれば、完了となります。

 

以上がGitHubでリポジトリを作る一連の流れになります。

LICENSEなどの種類も多く存在するので、ご自身のリポジトリ用途に合わせて選んでくださいね。

またGitHubはコマンド操作も多様かつ扱いやすいので、GitHubに慣れてきたらコマンドの扱い方も覚えていくと良いと思います。

 

お疲れ様でした。

git_repository_thumbnail
学びに関する情報をチェック!