~jacksonchen666/quick_statement_generator_for_software_version_identifier

9c1eb78b668c1b81704cec6ddfd43ff8eb504d4d — Jackson Chen 10 months ago f41d4d6
basically rewrite readme a bit
2 files changed, 15 insertions(+), 14 deletions(-)

M README.md
M TODO.md
M README.md => README.md +14 -14
@@ 3,8 3,8 @@ this program was made to add all the missing software versions/releases on [wiki

this was created in an effort to do more programming (due to the lack thereof ([website](https://git.sr.ht/~jacksonchen666/jacksonchen666.com) does not count)), and to fill in the gaps of [synapse](https://www.wikidata.org/wiki/Q58630176) on wikidata with the [software version identifier] section (it's like, a bit less than a year behind as of 2022-05-18).

for changes of adding 1 new version after a new release, this software is not made for that.
you can easily do that with the wikidata interface it has (given that you enabled javascript if you disabled it).
this is intended for big gaps, not new releases. you can use the wikidata
interface to add a single new release too.

# install



@@ 12,25 12,25 @@ you can easily do that with the wikidata interface it has (given that you enable
go install git.sr.ht/~jacksonchen666/quick_statement_generator_for_software_version_identifier/cmd/QSGSVI@latest
```

# building
assuming you have the source code already, `cd` into `cmd/QSGSVI/` and run `go build .`
# building (for devs not users)
`go build ./cmd/QSGSVI/`

# usage
use the `--help` flag to change some parameters to adjust to what you're going to deal with (which github project and which wikidata item).
run `-help` for command arguments.

if there are some differences (like how release candidate is indicated for version type), please modify the source code and build the program.
a github project must be specified, and a wikidata item must be specified.

note: the output is sorted from the newest release to the oldest, and it is very likely to match on wikidata after adding it.
to reverse the output, i'd suggesting using the `tac` command like it's `cat` (see man page for more info)
if there are some differences in interpretation (like `rc` means release candidate for version type), please modify the source code yourself.

this program also outputs the generated thing to stdout, so use your shell redirection to write stdout to the file (output not related to the generated output will be put on stderr)
note: the output is sorted from the newest release at the top, to the oldest at the bottom, and it will match on wikidata after adding it.
to reverse the output, i'd suggesting using the `tac` command like it's `cat` (see man page for more info)

# in quickstatements
copy the output of the program, and don't run it in the background or in batch mode.
the drawbacks of [batch mode](https://www.wikidata.org/wiki/Help:QuickStatements#When_to_use_batch_mode?) (high error rate on complex statements (statements with properties and sources)) just makes it not worth even retrying constantly, since everything will be out of order for some reason.
quickstatments are on stdout, everything else stderr.

# TODO
- [ ] authenticate to github for higher rate limits for more items
## in quickstatements
copy the output of the program, import as v1 commands, and do not use "batch
mode" or "run in background" because that won't work and will break
everything.

# license
    QSGSVI. Generates quickstatements for missing software versions.

M TODO.md => TODO.md +1 -0
@@ 1,3 1,4 @@
# features TODO
- [ ] authenticate to github for higher rate limits for more items
- [ ] add additional information to existing statements if not yet added
- [x] detecting beta, pre-releases, and alpha releases (based on [this](https://github.com/Chocobozzz/PeerTube/releases/tag/v1.0.0-beta.9))