"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "README.md" between
versions-1.5.4.tar.gz and versions-1.5.5.tar.gz

About: versions checks releases and versions of your favorite programs (on the main repositories) through RSS or Atom feeds.

README.md  (versions-1.5.4):README.md  (versions-1.5.5)
skipping to change at line 21 skipping to change at line 21
It can check projects from : It can check projects from :
* github.com * github.com
* sourceforge.net * sourceforge.net
* freshcode.club * freshcode.club
* pypi.python.org * pypi.python.org
* savanah.gnu.org * savanah.gnu.org
* www.freshports.org (FreeBSD packages) * www.freshports.org (FreeBSD packages)
* fossies.org * fossies.org
* repo.continuum.io * repo.continuum.io
* sourcehut forge
* gitlab forge
Projects must be added to a YAML file (named by default Projects must be added to a YAML file (named by default
`~/.config/versions/versions.yaml`). One can use `--file=FILENAME` `~/.config/versions/versions.yaml`). One can use `--file=FILENAME`
option to specify an alternative YAML file. The structure of this option to specify an alternative YAML file. The structure of this
YAML file is explained below. YAML file is explained below.
Versions uses and produces text files. Those files are cache files Versions uses and produces text files. Those files are cache files
written into `~/.local/versions` directory. `*.cache` are cache written into `~/.local/versions` directory. `*.cache` are cache
files containing the project list and their associated version (the latest). files containing the project list and their associated version (the latest).
`*.feed` are information feed cache files containing on each line `*.feed` are information feed cache files containing on each line
the latest parsed post of the feed. the latest parsed post of the feed.
# YAML file structure # YAML file structure
``` ```
sitename: sitename:
url: "https://the.url/to/theglobalfeed" url: "https://the.url/to/theglobalfeed"
type: list type: list
projects: projects:
- list - list
- of - of
- projects - projects
skipping to change at line 69 skipping to change at line 71
* 'byproject": The site gives access to one feed per project. * 'byproject": The site gives access to one feed per project.
brackets '{}' represents the name of the project as found in brackets '{}' represents the name of the project as found in
the 'project' list. Those projects can be listed directly or the 'project' list. Those projects can be listed directly or
can take options. In the later case you have to name the can take options. In the later case you have to name the
project and then you can specify either a regex or an entry project and then you can specify either a regex or an entry
type option: regex is used to determine version number and type option: regex is used to determine version number and
entry is used to determine if versions has to print the latest entry is used to determine if versions has to print the latest
entry (default behavior) or all entries from the "last checked" entry (default behavior) or all entries from the "last checked"
time. time.
A real life example file is provided: [versions/versions.yaml](versions/versions
.yaml)
# Installation # Installation
Installation of versions is not mandatory and you can invoke it Installation of versions is not mandatory and you can invoke it
directly from the command line provided you have already installed directly from the command line provided you have already installed
its requirements. its requirements.
## Pypi ## Pypi
In pypi the project is named program_versions but is still invoked In pypi the project is named program_versions but is still invoked
by the command `versions` : by the command `versions` :
 End of changes. 3 change blocks. 
1 lines changed or deleted 6 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)