Skip to content

Creating a Profile README

About Profile README

You can share information about yourself by creating a README for your profile. The README will be displayed at the top of your profile page.

You decide what information to include in your profile README, giving you full control over how you present yourself on GitFlic. Here are some examples of information visitors might find interesting, fun, or useful in your profile README:

  • An "About Me" section describing your work and interests
  • Projects you're proud of
  • Other information that might interest other users

Requirements

We can only display your profile README if all the following conditions are met:

  1. You've created a repository with a name matching your GitFlic username
  2. The repository is public
  3. The repository contains a file named README.md in its root directory
  4. The README.md file contains some content

Creating a Profile README

  1. In the top-right corner of any page, click "+" and create a new project
  2. In the "Project Name" field, enter a name matching your GitFlic username (e.g., if your username is "gitflicuser", the repository name should be "gitflicuser")
  3. Optionally, add a project description
  4. Check the "Public Project" checkbox
  5. Click "Create Project"
  6. Clone the repository or connect to the remote repository
  7. Create a README.md file in the root folder and populate it with your preferred content using Markdown
  8. Commit your changes and push them to the remote repository

If all steps are completed correctly, your README will be displayed on your profile under the "Overview" tab.

Automatic Translation!

This page was automatically translated. The text may contain inaccuracies