Creating a README from GitHub Desktop - treenabalds/How-To GitHub Wiki

Can you do it from the GitHub desktop app or only through the browser version?

Yes, you can create a README file using the GitHub Desktop app, though the process involves using a local repository and your preferred text editor. Here’s how you can do it:

  1. Clone the Repository Locally:

    • Open the GitHub Desktop app.
    • Select your repository from the list or clone it from GitHub if it’s not already there.

  2. Navigate to the Local Repository:

    • On your computer, go to the folder where your repository is stored.

  3. Create the README File:

    • In the local repository folder, create a new file named README.md. You can do this using any text editor (e.g., Notepad, VS Code, Sublime Text).
    • Add content to the file—describe your project, add installation instructions, etc.

  4. Save and Stage the Changes:

    • Save the file.
    • In the GitHub Desktop app, you’ll see the new README.md file listed as a change.

  5. Commit the Changes:

    • Add a commit message in the GitHub Desktop app (e.g., “Added README file”) and click “Commit to main” or the branch you’re working on.

  6. Push the Changes:

    • Click “Push origin” to upload the changes to the repository on GitHub.

Once you push the changes, your new README file will appear in the GitHub repository. This method works offline, allowing more flexibility with file creation and editing. Would you like tips on crafting a great README?