diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 33 |
1 files changed, 11 insertions, 22 deletions
@@ -8,14 +8,10 @@ For the most up-to-date documentation, please read the online build guide at VyOS is an open source operating system for network devices (routers, firewalls and so on). If you want to use it in your network, check out download and -installation instructions at https://vyos.io +installation instructions at https://docs.vyos.io/en/latest/installation/index.html If you want to modify VyOS and/or join its development, read on. -VyOS is not new. It is a fork of Vyatta Core that was created when the open -source version of it was discontinued. If you are a Vyatta Core user, you can -upgrade your installation to VyOS. - # About this repository VyOS is a GNU/Linux distribution based on Debian. Just like any other @@ -55,28 +51,21 @@ be found in our [Documentation - Build VyOS](https://docs.vyos.io/en/latest/cont # Development Branches -The default branch that contains the most recent VyOS code is called `current` -rather than `master`. We know it's confusing, but it's not easy to fix. In a -nutshell, the code we inherited from Vyatta Core had its `master` branch so out -of sync with everything it was beyond any repair. Vyatta developers used to create -a new branch not when a release is ready for code freeze, but rather before -starting to work on a new release. This is hard to change in existing code, so -this is just the way it is, for now. +The default branch that contains the most recent VyOS code is called `current`. +We may or may not eventually switch to `main`. -All new code goes to the `current` branch. When it's time for a code freeze, a +All new code goes to the `current` branch. When a new LTS release is ready for feature freeze, a new branch is created for the release, and new code from `current` is backported to the release branch as needed. -In packages that originate from VyOS the master branch is kept in sync with -`current`, but we still use `current` as default branch for uniformity. When the -last legacy package is gone, we will switch to using the `master` branch and -retire `current`. - Post-1.2.0 branches are named after constellations sorted by area from smallest to largest. There are 88 of them, here's the [complete list](https://en.wikipedia.org/wiki/IAU_designated_constellations_by_area). -* VyOS 1.2: `crux` (Southern Cross) -* VyOS 1.3: `equuleus` (Little Horse) -* VyOS 1.4: `sagitta` (Arrow) -* ... +Existing branches: + +* VyOS 1.4: `sagitta` (Arrow) [LTS] +* VyOS 1.3: `equuleus` (Little Horse) [LTS] +* VyOS 1.2: `crux` (Southern Cross) [Unsupported] + +The next LTS release will be VyOS 1.5 `circinus` (Compasses). |