Skip to content
This repository has been archived by the owner on Jul 3, 2024. It is now read-only.

Minor fix #68

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,22 @@ the directory [docs](./docs).

## Quick install with Opam

You can install wcs-ocaml with the following command:
You can install `wcs-ocaml` with the following command:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't like this formating. We prefere to keep wcs-ocaml.

```
opam install wcs
```

This will install the three main packages:
```
- wcs-lib,
- wcs-api and,
- wcs-api
- wcs

```

## Install from source with Opam

Opam can also be used to compile and install from the source
directory. For that you first need to pin the source directory.
directory. For that, you first need to pin the source directory.
So, from this directory, do:
```
opam pin add wcs-lib .
Expand Down Expand Up @@ -88,7 +89,7 @@ grep -r -e '\d\d\d\d-\d\d-\d\d.\d\d-dev' .

3. Update the `CHANGES.md` file.

4. Create a new release on the github interface:
4. Create a new release on the Github interface:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It should be GitHub.

https://github.com/IBM/wcs-ocaml/releases

5. Create a new release of the opam packages.
Expand Down Expand Up @@ -125,7 +126,7 @@ cp packages/wcs-lib/wcs-lib.XXXX-XX-XX.XX/url packages/wcs/wcs.XXXX-XX-XX.XX/url
```
git push origin wcs-XXXX-XX-XX.XX
```
- Create a pull request from the github interface:
- Create a pull request from the Github interface:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

idem.

https://github.com/ocaml/opam-repository

6. Once the pull request is accepted update the version number.
Expand Down