Skip to content

Commit

Permalink
Update documentation, adapt it to the new repository URL
Browse files Browse the repository at this point in the history
  • Loading branch information
npasserini committed May 27, 2016
1 parent c9aa858 commit 3ba35eb
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,21 @@ This is only a prototype and is not yet ready for production, but you are invite
- Git v1.9.1 or later
- An [SSH Key](https://help.github.com/articles/generating-an-ssh-key/)

### Install pharo-git
### Install Iceberg
```
Metacello new
baseline: 'Iceberg';
repository: 'github://npasserini/pharo-git';
repository: 'github://npasserini/iceberg';
onConflict: [:ex | ex allow];
load.
```

### Update Iceberg (since v0.0.3)
```
Iceberg update
```


## Usage
### Creating and retreiving repositories.
A repository is created out of an SCP URL (with the form `[user@]host:filename`, frequently `[email protected]:username/projectname.git`).
Expand All @@ -31,7 +37,7 @@ When the repository gets first used, it will create a local clone in your disk.
If you prefere to do clones at specific locations, you can provide a directory:
```
myRepo := IceRepository new
origin: '[email protected]:npasserini/pharo-git.git';
origin: '[email protected]:npasserini/iceberg.git';
localDirectory: ... absolute or relative path
```

Expand All @@ -58,6 +64,10 @@ If you want to create a new branch it is slight different:
myRepo loadPackage: 'Package-Name'
```

### Update packages
- `myRepo pull` will update all the packages in the repo (that have already been loaded).
- To update an individual package you can write: `myRepo updatePackage: 'Some-Package-Name'`

### Commit your changes
After making some changes, you can use the IceSynchronizer to commit them:
```
Expand Down

0 comments on commit 3ba35eb

Please sign in to comment.