Skip to content

Latest commit

 

History

History
57 lines (35 loc) · 2.3 KB

setup.md

File metadata and controls

57 lines (35 loc) · 2.3 KB
title subject venue
Repository Setup
Preparing your submission
Repository Setup

Submission templates are available via the Notebooks Now! GitHub Organization (github.com/Notebooks-Now).

🛠 Select one of the full templates corresponding to the authoring tools you wish to use for your submission, either MyST Markdown or Quarto.

🛠 To create your own submission repository on GitHub, click Use This Template and select Create a new repository.

🛠 Enter the details for your new repository.

  • Choose a unique name for the repository
  • Add a meaningful description
  • Mark the repository as public or private. Links to public repositories can be provided directly to the NN submission system, which will clone a copy, while private repositories will be submitted via a .zip file. Repositories on GitHub can be made public/private at a later time.

🪄 The new repository is now available in your GitHub account.

🛠 Make a local working copy of your repository.

How you create a local clone of your repository depends on how you are used to working with git. Assuming that you are using the git command line and have ssh configured:

  • copy the ssh clone URI from GitHub (as shown above)
  • Open a terminal or command prompt and navigate to a suitable working folder
  • run git clone [email protected]:username/my-repo.git, replacing the git URI with your own
:class: dropdown
Add some information on how to get started with git in different ways? command line, windows, codespaces

Next step

You have now created your own repository that you can start working in. The repository has example content, configuration files, an example executable environment and GitHub actions that automate preview builds of your content.

Next, learn about the structure of the repository and how you can customize it to fit your submission.