Skip to content

Commit

Permalink
Minor layout fix in User Guide (#614)
Browse files Browse the repository at this point in the history
  • Loading branch information
cjolowicz committed Oct 10, 2020
1 parent f323a03 commit a3c9f00
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -296,12 +296,14 @@ replace ``<project>`` by the name of your project.
$ git commit
Use the following command to ensure your default branch is called ``main``,
the `new default for GitHub repositories`__:

$ git branch -M main
which is the `default branch name for GitHub repositories`__.

__ https://github.com/github/renaming

.. code:: console
$ git branch --move --force main
Create an empty repository on GitHub_,
using the project name you chose when you generated the project.

Expand All @@ -312,11 +314,11 @@ using the project name you chose when you generated the project.

Finally, upload your repository to GitHub.
In the commands below, replace ``<username>`` by your GitHub username,
and ``<repository>`` by the name of your GitHub repository.
and ``<project>`` by the name of your project.

.. code:: console
$ git remote add origin git@github.com:<username>/<repository>.git
$ git remote add origin git@github.com:<username>/<project>.git
$ git push --set-upstream origin main
Now may be a good time to set up Continuous Integration for your repository.
Expand Down

0 comments on commit a3c9f00

Please sign in to comment.