Skip to content

Commit

Permalink
Merge pull request #40 from ProjectTorreyPines/docs
Browse files Browse the repository at this point in the history
Added link for adding ssh-key to Github
  • Loading branch information
anchal-physics committed Feb 14, 2024
2 parents e1e6a36 + 58148eb commit e6bb21f
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,16 @@ Steps:

## Installation

### Cloning using ssh

It is recommended to setup github access for your account using a ssh key. Please follow
github intstructions for [connecting to github with ssh](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). The make file below and other steps uses ssh clone url and would
fail unless you have access to github setup using ssh key. If you prefer to use password for login, correct clone urls accordingly.

### Using make file

This option only works on and has been tested on macOS and unix. If you have windows, please use the [manual instructions](https://github.com/ProjectTorreyPines/SD4SOLPS.jl/wiki) instead.

#### Option 1: Download the [example directory](https://github.com/ProjectTorreyPines/SD4SOLPS.jl/tree/master/example) in this repo:

```bash
Expand Down

0 comments on commit e6bb21f

Please sign in to comment.