redme update

This commit is contained in:
Harald Hope 2023-09-17 21:20:49 -07:00
parent 089766b34e
commit 8bf3bae552

View file

@ -99,32 +99,37 @@ See BSD/UNIX below for qualifications re BSDs, and OSX in particular.
SOURCE VERSION CONTROL SOURCE VERSION CONTROL
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
inxi:
https://codeberg.org/smxi/inxi https://codeberg.org/smxi/inxi
MAIN BRANCH: master MAIN BRANCH: master
DEVELOPMENT BRANCHES: inxi-perl, one, two DEVELOPMENT BRANCHES [not used]: one, two
inxi-perl is the dev branch, the others are rarely if ever used. inxi itself has pinxi:
the built in feature to be able to update itself from anywhere, including these https://codeberg.org/smxi/pinxi
branches, which is very useful for development and debugging on various user
systems. pinxi is the standalone development repo, the others are rarely if ever used.
inxi has the built in feature to be able to update itself from anywhere,
including these branches, which is very useful for development and debugging on
various user systems.
PULL REQUESTS: Please talk to me before starting to work on patches of any PULL REQUESTS: Please talk to me before starting to work on patches of any
reasonable complexity. inxi is hard to work on, and you have to understand how reasonable complexity. inxi is hard to work on, and you have to understand how
it works before submitting patches, unless it's a trivial bug fix. Please: NEVER it works before submitting patches, unless it's a trivial bug fix. Please: NEVER
even think about looking at or using previous inxi commits, previous to the even think about looking at or using previous inxi commits, previous to the
current master version, as a base for a patch. If you do, your patch / pull current master version, as a base for a patch. If you do, your patch / pull
request will probably be rejected. Developers, get your version from the request will probably be rejected. Developers, get your version from the pinxi
inxi-perl branch, pinxi, otherwise you may not be current to actual development repo, master branch, otherwise you may not be current to actual development
versions. inxi-perl pinxi is always equal to or ahead of master branch inxi. versions. pinxi is always equal to or ahead of master branch inxi.
Man page updates, doc page updates, etc, of course, are easy and will probably Man page updates, doc page updates, etc, of course, are easy and will probably
be accepted, as long as they are properly formatted and logically coherent. be accepted, as long as they are properly formatted and logically coherent.
When under active development, inxi releases early, and releases often. When under active development, pinxi releases early, and releases often. inxi
is stable and is generally only updated when a new tagged version is completed.
PACKAGERS: inxi has one and only one 'release', and that is the current PACKAGERS: inxi has one and only one 'release', and that is the current
commit/version in the master branch (plus pinxi inxi-perl branch, of course, but commit/version in the master branch (plus pinxi repo, of course, but those
those should never be packaged). should never be packaged).
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
MASTER BRANCH MASTER BRANCH
@ -145,9 +150,9 @@ OR easy to remember shortcut (which redirects to codeberg.org):
wget -O inxi https://smxi.org/inxi wget -O inxi https://smxi.org/inxi
wget -O inxi smxi.org/inxi wget -O inxi smxi.org/inxi
NOTE: Just because codeberg.org calls tagged commits 'Releases' does not mean they are NOTE: There are no 'Releases' per se. There are only tagged commits, period. A
releases! I can't change the words on the tag page. They are tagged commits, tag is a pointer to a commit, and has no further meaning. A tagged commit
period. A tag is a pointer to a commit, and has no further meaning. however is the target for packagers.
If your distribution has blocked -U self updater and you want a newer version: If your distribution has blocked -U self updater and you want a newer version:
@ -167,16 +172,16 @@ to download the file.
For pinxi, just change inxi to pinxi above, and it will work the same. For pinxi, just change inxi to pinxi above, and it will work the same.
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
DEVELOPMENT BRANCH DEVELOPMENT VERSION (in pinxi repo)
-------------------------------------------------------------------------------- --------------------------------------------------------------------------------
All active development is now done on the inxi-perl branch (pinxi): All active development is done in the pinxi repo master branch.:
git clone https://codeberg.org/smxi/inxi --branch inxi-perl --single-branch git clone https://codeberg.org/smxi/pinxi
OR direct fast and easy install: OR direct fast and easy install:
wget -O pinxi https://codeberg.org/smxi/inxi/raw/inxi-perl/pinxi wget -O pinxi https://codeberg.org/smxi/pinxi/raw/master/pinxi
OR easy to remember shortcut (which redirects to codeberg.org): OR easy to remember shortcut (which redirects to codeberg.org):
@ -364,10 +369,14 @@ SUPPORTED VERSIONS / DISTRO VERSIONS
Important: the only version of inxi that is supported is the latest current Important: the only version of inxi that is supported is the latest current
master branch version/commit. No issue reports or bug reports will be accepted master branch version/commit. No issue reports or bug reports will be accepted
for anything other than current master branch. No merges, attempts to patch old for anything other than current master branch. No merges, attempts to patch old
code from old versions, will be considered or accepted. If you are not updated code from old versions, will be considered or accepted on the master branch of
to the latest inxi, do not file a bug report since it's probably been fixed ages inxi. If you are not updated to the latest inxi, do not file a bug report since
ago. If your distro isn't packaging a current inxi, then file a bug report with it's probably been fixed ages ago. If your distro isn't packaging a current
your packager, not here. inxi, then file a bug report with your packager, not here.
The development branch inxi-perl/pinxi has been moved to its own standalone
repo, pinxi, at https://codeberg.org/smxi/pinxi - this is the only place
development happens.
inxi is 'rolling release' software, just like Debian Sid, Gentoo, or Arch Linux inxi is 'rolling release' software, just like Debian Sid, Gentoo, or Arch Linux
are rolling release GNU/Linux distributions, with no 'release points'. are rolling release GNU/Linux distributions, with no 'release points'.