Skip to content

Commit

Permalink
Revise installation instructions for period of pre-SSC publication.
Browse files Browse the repository at this point in the history
  • Loading branch information
arthur-shaw committed May 9, 2024
1 parent c2b0f3e commit b809d83
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Note also: while this package does not require [selector](https://github.com/lsm

## Installation

To install the latest published version of the package:
<!-- To install the latest published version of the package:
```stata
* install the package from the SSC package repository
Expand All @@ -28,18 +28,22 @@ To update the package:
adoupdate labeller
```
If there are updates, Stata will instruct you how to apply them.
If there are updates, Stata will instruct you how to apply them. -->

### Development version

The version of `labeller` on SSC corresponds to the code in the `main` branch of [the package's GitHub repository](https://github.com/lsms-worldbank/labeller).

To get a bug fix or test bleeding-edge features, you can install code from other branches of the repository. To install the version in a particular branch:
<!-- The version of `labeller` on SSC corresponds to the code in the `main` branch of [the package's GitHub repository](https://github.com/lsms-worldbank/labeller). -->

To get a bug fix, a version not yet published on SSC, or test bleeding-edge features, you can install code from other branches of the repository. The current release is version 0.5.

To install the version in a particular branch:

```stata
* set tag to be the name of the target branch
* for example, the development branch, which contains code for the next release
local tag "dev"
* alternatively, v0.5, which contains the code for the current pre-SSC release.
* download the code from that GitHub branch
* install the package
net install labeller, ///
Expand Down

0 comments on commit b809d83

Please sign in to comment.