Skip to content

Commit 876efa7

Browse files
committed
updated readme with some information about version numbers
1 parent 7b19498 commit 876efa7

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22

33
The San Andreas Multiplayer Pawn Standard Library Package - designed for the [sampctl package management system](http://sampctl.com).
44

5+
The current latest version is **0.3.7-R2-2-1**.
6+
7+
The master branch HEAD does not currently contain any RC libaries.
8+
59
## Why?
610

711
The package management system built into the `sampctl` tool is based on GitHub (Simiar to that of the Go language) so it simplifies the process to have the standard library stored here on GitHub too. This means there doesn't need to be any special-case code written for the standard library, it can just be a package like all others.
12+
13+
## How Do Versions Work?
14+
15+
### Versions are represented by [Git Tags](https://help.github.com/articles/working-with-tags/)
16+
17+
Always specify a version when working with sampctl. To depend on the latest version, simply use `sampctl/samp-stdlib:0.3.7-R2-2-1` as a dependency.
18+
19+
### What happens during Release Candidates (RCs)?
20+
21+
The `master` branch will contain RC libraries if there is an active RC. The most recent RC was 0.3.8, but since this was cancelled, this repository contains no 0.3.8 RC libraries.
22+
23+
### Version tags are fully compatible with [sampctl](https://github.com/Southclaws/sampctl/wiki/Dependencies#versioning)
24+
25+
[sampctl](http://bit.ly/sampctl) simplifies version control, this repository exists to help sampctl users who work with multiple SA:MP server versions.
26+
27+
### Versioning starts at 0.3z (specifically, 0.3z-R1) ### there are no earlier libraries in this repo
28+
29+
0.3z is the earliest version supported by [sampctl](http://bit.ly/sampctl). Most servers use the latest version so it didn't seem worth archiving every SA:MP library version.
30+
31+
### Some tags point to the same commit
32+
33+
Some releases only changed the server's internals and never touched the libraries. In these cases, the version tags still exist in this repo but they simply point to the same commit.

0 commit comments

Comments
 (0)