About READMEs
You can add a README file to a repository to communicate important information about your project. A README, along with a repository license and contribution guidelines, communicates expectations for your project and helps you manage contributions.
For more information about providing guidelines for your project, see "Setting up your project for healthy contributions."
A README is often the first item a visitor will see when visiting your repository. README files typically include information on:
- What the project does
- Why the project is useful
- How users can get started with the project
- Where users can get help with your project
- Who maintains and contributes to the project
If you put your README file in your repository's hidden .github
, root, or docs
directory, GitHub Enterprise Server will recognize and automatically surface your README to repository visitors.
If a repository contains more than one README file, then the file shown is chosen from locations in the following order: the .github
directory, then the repository's root directory, and finally the docs
directory.
自分のユーザ名と同じ名前のパブリックリポジトリのルートにREADMEファイルを追� したなら、そのREADMEは自動的に自分のプロフィールページに表示されます。 プロフィールのREADMEは、GitHub形式のMarkdownで編集し、プロフィール中にパーソナライズされたセクションを作成できます。 詳細については、「プロファイルの README を管理する」を参照してく� さい。
Auto-generated table of contents for README files
For the rendered view of any Markdown file in a repository, including README files, GitHub Enterprise Server will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the menu icon at the top left of the rendered page.
Section links in README files and blob pages
セクションのヘッディング上にカーソルを移動させてリンクを表示させることにより、表示されたファイル中のセクションに対して直接リンクできます。
Relative links and image paths in README files
表示されたファイル中で相対リンクと画像パスを定義して、読者がリポジトリ中の他のファイルにアクセスしやすくできます。
相対リンクは、現在のファイルに対する相対的なリンクです。 たとえば、リポジトリのルートに README ファイルがあり、docs/CONTRIBUTING.md に別のファイルがある� �合、README の CONTRIBUTING.md への相対リンクは次のようになります。
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub Enterprise Serverは相対リンクあるいは画像パスを、現在のブランチに基づいて変換するので、リンクやパスは常にうまく働きます。 リンクのパスは、現在のファイルに対する相対パスになります。 /
で始まるリンクは、リポジトリ ルートに対する相対パスです。 ./
や ../
のような相対リンクのオペランドをすべて使用できます。
相対リンクは、リポジトリをクローンするユーザにも扱いやすいです。 絶対リンクはリポジトリのクローンではうまく働かないかもしれません。リポジトリ内の他のファイルを参照するには、相対リンクを使うことをおすすめします。
Wikis
A README should contain only the necessary information for developers to get started using and contributing to your project. Longer documentation is best suited for wikis. For more information, see "About wikis."