Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add sfoundryup readme to seismic branch (was only on ameyas) #41

Merged
merged 1 commit into from
Dec 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions sfoundryup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,33 @@ To install the **nightly** version of Seismic Foundry tools:
```bash
sfoundryup
```

### Install a specific **version** (in this case the nightly version):
```bash
sfoundryup --version nightly
```
### Install a specific **branch** (in this case the seismic branch):
```bash
sfoundryup --branch seismic
```
### Install a **fork's main branch** (in this case YourUser/seismic-foundry's main branch):
```bash
sfoundryup --repo YourUser/seismic-foundry
```
### Install a **specific branch in a fork** (in this case the custom-branch branch's latest commit in YourUser/seismic-foundry):
```bash
sfoundryup --repo YourUser/seismic-foundry --branch custom-branch
```
### Install a **specific Pull Request**:
```bash
sfoundryup --pr 123
```
### Install from a **specific commit**:
```bash
sfoundryup -C abcdef1234567890
```
### Install from a **local directory or repository** (e.g., one located at ~/git/seismic-foundry, assuming you're in the home directory):
```bash
sfoundryup --path ./git/seismic-foundry
```
**Tip**: All flags have a single-character shorthand equivalent! You can use -v instead of --version, etc.
Loading