Skip to content

Company Readme

You can share information about how to interact with your company by creating a company README. GitFlic displays the README of your company profile on the "Overview" tab.

You choose what information to include in the README. Here are some examples of information that might be useful:

  • An "About the Company" section describing the structure and objectives.
  • A guide for getting help within the company.

Creating a Company README

  • Create a public project with a URL that matches your company's URL on GitFlic. The project must be owned by the company. Read more about creating a project here.
  • Clone or create a remote connection to the created project.
  • In the root of the project, create a README.md file and fill it with any information you like using Markdown.
  • Make a new commit and push the changes to the project.

If all steps are completed correctly, your company's README will be displayed on the "Company Overview" tab.

README

Automated translation!

This page was translated using automatic translation tools. The text may contain inaccuracies.