Skip to content

Commit

Permalink
Documentation update.
Browse files Browse the repository at this point in the history
  • Loading branch information
@bengtmartensson
bengtmartensson committed Mar 16, 2024
1 parent 4fde583 commit 482c596
Show file tree
Hide file tree
Showing 7 changed files with 82 additions and 54 deletions.
2 changes: 1 addition & 1 deletion BUILD.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Alternatively, the "compatibility layer capable of running
The Maven build creates a file
`IrScrutinizer-`_version_`-macOS.dmg`.
This file can be directly distributed to the users, to be installed according to
[these instructions](http://harctoolbox.org/IrScrutinizer.html#Mac+OS+X+app).
[these instructions](http://harctoolbox.org/IrScrutinizer.html#MacOS+app).

The icon file `IrScrutinizer.icns` was produced from the Crystal-Clear
icon `babelfish.png` in 128x128 resolution, using the procedure
Expand Down
18 changes: 1 addition & 17 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ The format of text files follows the requirement of portability:
* Text files that are only of interest for Windows (e.g.
<code>IrScrutinizer_inno.iss</code>) should use CRLF,
* Text files that a Windows user may open with Textedit
(e.g. <code>IrpProtocols.ini</code>) should use CRLF, unless this creates other problems,
should use CRLF, unless this creates other problems,
* Otherwise LF.

## Build process
Expand All @@ -45,19 +45,3 @@ belongs to Netbeans are clearly marked as such, and may not be hand
edited. (Some GUI files has been initially created by Netbeans, but
then "de-Netbeanized", identified by the lack of a .form file. The
paragraph does not apply to these, of course.)

## Git branches

(This section stolen from LIRC, with minor editing.) We basically use the branching
scheme described
[here](http://nvie.com/posts/a-successful-git-branching-model). However,
what is called 'devel' in that document we call 'master'. Likewise,
what is called 'master' there we call 'release'. In short:

* master is the current development, from time to time unstable.
* release contains the last stable version, and also all tagged releases.
* When a release is upcoming, we fork a release branch from master. This
is kept stable, only bug fixes are allowed. Eventually it is merged into
release and tagged.
* Other branches are feature branches for test and review. They can not
be trusted, and are often rewritten.
18 changes: 0 additions & 18 deletions ROADMAP.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,24 +38,6 @@ See [#15](https://github.com/bengtmartensson/IrScrutinizer/issues/15). The
[article on the web site](http://harctoolbox.org/IrScrutinizer.html) should be a "cool" article,
not a "dry" reference manual.

## 7. Porting/packaging
... to Android ([#81](https://github.com/bengtmartensson/IrScrutinizer/issues/81)),
ARM/RPi ([#68](https://github.com/bengtmartensson/IrScrutinizer/issues/68)),
misc systems ([#68](https://github.com/bengtmartensson/IrScrutinizer/issues/68)).
Any way to build inno setups in Github actions?
Flatpacks?

## 9. Advanced command line support.
IrpTransmogrifier has a quite clean and powerful command line interface; should probably not touch or replace that.
Presently, import files in Girr format can be given on the command line.
Should incorporate hardware support, see [#11 of HarcHardware](https://github.com/bengtmartensson/HarcHardwareBundle/issues/11).
Should allow for some use cases, that naturally leads themselvs for non-interactive
exection, see [this discussion](https://github.com/bengtmartensson/IrScrutinizer/issues/26#issuecomment-431651739).
Still, a finished concept is missing.

## 10. Testing
I strive to have [TestNG](http://testng.org) based Java testing, integrated in Maven and Netbeans.

## -1. Internationalization
This is not at all an important issue for me, at least not for the moment.
(Despite being Swedish native speaker, and speaking German at work.) Sometimes, however,
Expand Down
46 changes: 45 additions & 1 deletion src/main/doc/IrScrutinizer.releasenotes.txt
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,52 @@
Release notes for IrScrutinizer, including IrpMaster/IrpTransmogrifier,
Girr, HardHardware, DevSlashLirc, and Jirc.
Girr, HardHardware, RemoteLocator, DevSlashLirc and Jirc.

The notation #n refers to issues number n at
https://github.com/bengtmartensson/IrScrutinizer/issues
==============================================================================
Version 2.4.1, released 2024-03-16.

* Use IrpTransmogrifier 1.2.14, Girr 2.2.14, Jirc 2.2.14, RemoteLocator 0.x.y, HarcHardware 2.4.1.
* Bugfix: Helptext links failed if the IrpProtocols pathname contained spaces.
* Remove option "Reject Lirc imports without timing". Resolves #522.
* Implemented secondary export formats file/directory. Resolves #294.
* Bugfix for files located within the directory applicationHome.
* Installation message windows (post_install.txt) update.
* Fix bug in Ctrl-F handling in tables. #387.
* Implemented secondary IrpProtocols file. #294.
* IrPlotter: improved mouse-based zooming. Resolves #361.
* Minor tweaks in IrPlotter: Fix glitch in plot scales, leading to overlapping text. #291.
* Remove GlobalCache IR database (old) importer. #516.
* Parametric and raw remote table now has search. #387.
* Say "delete", not "clear" on signals on some popup menus.
* Update the embedded Java JVM on Windows. #515.
* Update Java JVM for AppImage. #514.
* Option --scale now handled in the Java code, not in a wrapper. #513.
* Allow empty commands to be imported in Girr through Options -> Import options -> Accept empty Girr commands on import. #511.
* Windows: install wrapper for HarcHardware.
* AppImage: do not include /usr/lib/rxtx and /usr/lib64/lib any more, not used anymore.
* AppImage can now invoke HarcHardware's main routine, just as IrpTransmogrifier's. #464.
* Silly case sensitivity fixed. #498.
* Export signal: check savefile for null-ness. #506.
* Robustness fix for appimages, see #498.
* Do not take frequency from GUI for signals without explicit frequency. #496.
* Two new/fixed export formats: Homeassistant Broadlink Switch and Homeassistant Broadlink remote. #477.
* New export format Homeassistant ITach (GlobalCache). Resolves #478.
* Fixes to Broadlink*formatter, to accomplish to RF support.
* Fix incorrect propertly name with lirc config (Thanks Bill Ryder)
* Export formats IrToy and IrToy-bin fixed. #482.
* Fix GuiMain.analyzerMaxParameterWidth for changes in IrpTransmogrifier, #234.
* Partial fix of the Homeassistant-Broadlink export format, #477.
* Added Discussions item under Help menu.
* Some Arduino export fixes. #476, #413, #444, #476
* Do not use deprecated Girr functions. #474.
* Replace minimal-json library. #473.
* Robustness fixes for export GUI.
* Delete original pronto hex in the pronto oneshot export.
* Misc Broadlink signals fixes, both hex and base64. #375, #472.
* New export format tester-arduino.
* Change she-bang of setup-irscrutinizer.sh to say /bin/bash explicitly. #470.

==============================================================================
Version 2.4.0, released 2022-12-20.

Expand Down
Binary file modified src/main/doc/pom-deps.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
48 changes: 33 additions & 15 deletions src/main/xdocs/IrScrutinizer.xml
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<?xml-stylesheet type="text/xsl" href="xdoc2html.xsl"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "https://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>IrScrutinizer documentation</title>
Expand Down Expand Up @@ -102,6 +102,10 @@
<td>2024-01-05</td>
<td>Removed GlobalCache IR database.</td>
</tr>
<tr>
<td>2024-03-12</td>
<td>Added link to Lirc imports with and without timing info. Updated command line parameters. Misc fixes and updates.</td>
</tr>
</table>

<section>
Expand Down Expand Up @@ -337,7 +341,9 @@
be opened by double clicking them.</p>

<p>The installer will also install the command line program <a href="IrpTransmogrifier.html">IrpTransmogrifier</a>,
which can be called as <code>irptransmogrifier</code> from a command line window.</p>
which can be called as <code>irptransmogrifier</code> from a command line window.
This also goes for <a href="HarcHardware.html">HarcHardware</a>.
</p>

<p>Sometimes, when starting the program for the first time, the Windows Defender Firewall blocks some features in the program,
asking for permission to allow the Java virtual machine (typically ending with <code>javaw.exe</code>) access. This should be granted.</p>
Expand Down Expand Up @@ -411,6 +417,7 @@
<source>
ln -s /usr/local/share/irscrutinizer/irscrutinizer.sh /usr/local/bin/irscrutinizer
ln -s /usr/local/share/irscrutinizer/irscrutinizer.sh /usr/local/bin/irptransmogrifier
ln -s /usr/local/share/irscrutinizer/irscrutinizer.sh /usr/local/bin/harchardware
</source>
<!--p>If your system comes with a natively and working RXTX, you should preferably use that. However, Fedora currently
<a href="https://bugzilla.redhat.com/show_bug.cgi?id=1645856">ships with unusable RXTX</a>. See
Expand Down Expand Up @@ -458,7 +465,9 @@
<section>
<title>Linux/Unix Serial device access</title>
<p>To access serial devices, including "serial" devices connected over USB, most current Linuxes
require the current user to be a member of the group <code>dialout</code>, in some cases (e.g. Fedora) also
require the current user to be a member of the group <code>dialout</code>
(some distributions use the legacy name <code>uucp</code>),
in some cases (e.g. Fedora) also
the group <code>lock</code>. To grant user <code>$USER</code> this membership, typically a
command like
<code>sudo usermod -aG dialout $USER</code>, and/or <code>sudo usermod -aG lock $USER</code> is used.
Expand Down Expand Up @@ -866,11 +875,14 @@
<section>
<title>Lirc</title>
<p>The <a href="Glossary.html#Lirc">Lirc</a> import feature is based upon <a
href="https://github.com/bengtmartensson/Jirc">Jirc</a>, which is basically a subset of Lirc translated into Java.
href="https://github.com/bengtmartensson/Jirc">Jirc</a>, which is basically a subset of Lirc 0.9.0 translated to Java.
The Lirc importer can even import a file
system hierarchy by selecting the top directory as File/URL. (Importing the
entire lirc.org database with over 100000 commands takes around 1 minute and 1GB
of memory.)</p>

<p>Only Lirc remotes with timing information can be imported, not the so-called lircccode remotes.
See <a href="https://github.com/bengtmartensson/IrScrutinizer/discussions/521">this article</a> for a more extensive discussion.</p>
</section>

<section>
Expand Down Expand Up @@ -1458,20 +1470,26 @@ module is then accessed using the UDP text mode.</p>
causing commands like sending to IR
hardware printing some messages in the console.</p>

<p>Using the option <code>--properties</code> (or <code>-p</code>), an alternative property file can be used.
If installing more than one version of the program, this is recommended practice.</p>

<p>The option <code>--nuke-properties</code> makes the program delete the property file, and exit immediately.</p>

<p>For automating tasks, or for integrating in build processes or Makefiles or
the like, it
is probably a better idea to use IrpTransmogrifier instead, which has a
reasonably complete <a href="IrpTransmogrifier.html#Usage+of+the+program+from+the+command+line">command line interface</a>.</p>
<p>The option <code>--scaling</code> (or <code>-s</code>, <code>--scale</code>)
set the scaling of the GUI. Accepted values and their semantics depend on the JVM used.</p>

<p>IrpTransmogrifier as command line program can be invoked with the AppImage installation by
calling it using the name <code>irptransmogrifier</code> (through copying or linking).</p>
<p>IrpTransmogrifier as well as <a href="HarcHardware.html">HarcHardware</a> as command line program can be invoked with the AppImage installation by
calling it using the name <code>irptransmogrifier</code> or <code>harchardware</code> (through copying or linking).</p>

<p>The MacOS App does not support calling IrpTransmogrifier; install the generic binary version if needed.</p>
<p>The MacOS App does not support calling IrpTransmogrifier or HarcHardware; install the generic binary version if needed.</p>

<p>The program delivers well defined and sensible exit codes, listed
<a href="https://github.com/bengtmartensson/IrpTransmogrifier/blob/master/src/main/java/org/harctoolbox/irp/IrpUtils.java">in the code</a>.</p>

<p>For automating tasks, or for integrating in build processes or Makefiles or
the like, it
is probably a better idea to use IrpTransmogrifier instead, which has a
reasonably complete <a href="IrpTransmogrifier.html#Usage+of+the+program+from+the+command+line">command line interface</a>.</p>
</section>

<section>
Expand Down Expand Up @@ -1634,7 +1652,7 @@ module is then accessed using the UDP text mode.</p>
<ul>
<li>For GlobalCache this is TCP port 4998. Its discovery beacon uses UDP port 9131.</li>
<li>Lirc uses a TCP port, per default 8765.</li>
<li>IrTrans uses a UDP port, per default 21000.</li>
<!--li>IrTrans uses a UDP port, per default 21000.</li-->
<li>AGirs on an ethernet connected board uses a TCP port, per default 33333.</li>
</ul>
<!--p>TODO: describe configuration of firewall/packet filter on Windows and others. (Help welcome!)</p-->
Expand Down Expand Up @@ -1800,10 +1818,10 @@ module is then accessed using the UDP text mode.</p>
Exactly the same thing goes for the raw table. So, it is not "multiple", it may be at most two;
they are not identical (but very similar). There is also a "Do not ask this again" checkbox.</p>
</section>
<section>
<!--section>
<title>Do you solicit or accept donations?</title>
<p>No.</p>
</section>
</section-->
</section>
<section id="building-from-sources">
<title>Appendix. Building from sources</title>
Expand Down Expand Up @@ -1930,7 +1948,7 @@ module is then accessed using the UDP text mode.</p>
<em>version</em>
<code>-macOS.dmg</code>.
This file can be directly distributed to the users, to be installed according to
<a href="#Mac+OS+X+app">these instructions</a>.</p>
<a href="#MacOS+app">these instructions</a>.</p>

<p>The icon file <code>IrScrutinizer.icns</code> was produced from the Crystal-Clear
icon <code>babelfish.png</code> in 128x128 resolution, using the procedure
Expand Down
4 changes: 2 additions & 2 deletions src/main/xml/Version.xml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE version PUBLIC "-//harctoolbox.org//version//en" "http://www.harctoolbox.org/dtds/version.dtd">
<!--
Copyright (C) 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Bengt Martensson.
Copyright (C) 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024 Bengt Martensson.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Expand All @@ -19,7 +19,7 @@ this program. If not, see http://www.gnu.org/licenses/.
<version appName="IrScrutinizer" package = "org.harctoolbox.irscrutinizer">

<!-- Verbal description of the license of the current work. -->
<licenseString>Copyright (C) 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Bengt Martensson.\n\n
<licenseString>Copyright (C) 2013, 2014, 2015, 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024 Bengt Martensson.\n\n
This program is free software: you can redistribute it and/or modify it under the terms
of the GNU General Public License as published by the Free Software Foundation;
either version 3 of the License, or (at your option) any later version.\n\n
Expand Down

0 comments on commit 482c596

Please sign in to comment.