Skip to content

Commit

Permalink
Added a note in README on managing upstream URLs. (#58)
Browse files Browse the repository at this point in the history
Added a note pointing to the GitHub documentation with instructions on
adding an upstream URL to the generated project.

---------

Co-authored-by: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com>
  • Loading branch information
santacodes and agriyakhetarpal authored Aug 31, 2024
1 parent 9f9f180 commit 90429df
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,8 @@ pybamm-cookie
Copier will prompt you with various configurations and you may choose the ones that suit your use case.
Additionally you can perform `pybamm-cookie -h` to know the list of actions you can perform with the CLI.

**Note**: A `git` repository is automatically initialised when a project is created within a directory.
> [!NOTE]
> A `git` repository is automatically initialised when a project is created within a directory. To push the contents to the upstream GitHub repository, create a GitHub repository with the same name as your local repository and do not initialise your GitHub repository with any files such as licenses or README which might conflict with the local repository, follow these steps as listed in the [GitHub documentation](https://docs.github.com/en/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github#adding-a-local-repository-to-github-using-git).
After generation, you can navigate to the generated project and run `nox -s generated-project-tests` to ensure if the project units are working as intended.

Expand Down

0 comments on commit 90429df

Please sign in to comment.