Update README.md #1791
Update README.md #1791
Conversation
Altered the Linux installation instructions, from the perspective of a Linux n00b.
README.md
Outdated
| * (5.0.0+) chrome_crashpad_handler `chmod +x chrome_crashpad_handler` | ||
| 1. Run INAV Configurator app from unpacked folder | ||
| 2. Download Configurator for Linux platform (linux32 and linux64 are present) | ||
| * **.rpm** is the Fedora installation file. Just download and run to install INAV Configurator |
There was a problem hiding this comment.
This is not an executable file, you don't "run" it. You'd either:
- In a terminal
sudo dnf localinstall FILE.rpm; or - Open it with a package manager (e..g via the File Manager)
README.md
Outdated
| 1. Run INAV Configurator app from unpacked folder | ||
| 2. Download Configurator for Linux platform (linux32 and linux64 are present) | ||
| * **.rpm** is the Fedora installation file. Just download and run to install INAV Configurator | ||
| * **.deb** is the Debian/Ubuntu installation file. Just download and run to install INAV Configurator |
There was a problem hiding this comment.
This is not an executable file, you don't "run" it. You'd either:
- In a terminal
sudo apt install /path/to/FILE.deb; or - Open it with a package manager (e.g. via the File Manager)
There was a problem hiding this comment.
I am getting old, my suggestion would have been dpkg -i file.deb :)
README.md
Outdated
| ``` | ||
| **NN** is the bits of your OS. **x.y.z** is the INAV Configurator version number. | ||
|
|
||
| 6. If this is the first time installing INAV Configurator, create a home for it's files |
There was a problem hiding this comment.
it's is a contraction (of it is), not a possessive, the apostrophe is not required.
There was a problem hiding this comment.
Some other comments:
For Linux, we should consolidate the permissions stuff which is an afterthought to to the README into the main Linux section (c. line 169 under Notes ATM)
The heading "Building and running INAV Configurator locally (for development or Linux users)" might drop the "or Linux users" as this is a relic of the time when there were no Linux installers / tarballs released.
In the "Mac" section, we now sign released installers, so the signing comment is obsolete for the MacOS package (*.dmg)?
Anyway, good work; not before time.
Updates based on @stronnag suggestions
|
Thanks @stronnag 👍🏻 |
Apologies that it got split up into small pieces. |
|
No problem. It was easy to go through and update like that. It's all good :) |
README.md
Outdated
| * (5.0.0+) chrome_crashpad_handler `chmod +x chrome_crashpad_handler` | ||
| 1. Run INAV Configurator app from unpacked folder | ||
| 2. Download Configurator for Linux platform (linux32 and linux64 are present) | ||
| * **.rpm** is the Fedora installation file. Just download and install using `sudo dnf localinstall /path/to/INAV-Configurator_linuxNN_x.y.z..rpm` or open it with a package manager (e.g. via Files) |
There was a problem hiding this comment.
Looks like we have 1 . too many in the rpm file name
There was a problem hiding this comment.
The filename wasn't quite right either. Corrected it and the .deb.
README.md
Outdated
| 10. Make the following files executable: | ||
| * inav-configurator `chmod +x /opt/inav/inav-configurator/inav-configurator` | ||
| * (5.0.0+) chrome_crashpad_handler `chmod +x /opt/inav/inav-configurator/chrome_crashpad_handler` | ||
| 11. Run INAV Configurator app from unpacked folder |
There was a problem hiding this comment.
From a beginner point of view, should we be obvious here and list the file path /opt/inav/inav-configurator/inav-configurator
or how to find it in applications?
There was a problem hiding this comment.
Finding it in "Applications" depends on the user's selected DE. It will be different in GNOME, KDE, Xfce and the myriad of others.
There was a problem hiding this comment.
I usually would run things from the terminal anyway.
It is probably a good idea to make it obvious that you should run /opt/inav/inav-configurator/inav-configurator to launch inav as the readon why they did the chmod +x on the steop before may not be obvious to a beginner.
|
|
||
| On some Linux distros, you may be missing `libatomic`, a `NW.JS` (specially `libnode.so`) dependency. If so, please install `libatomic` using your distro's package manager, e.g: | ||
|
|
||
| * Arch Linux: `sudo pacman -S --needed libatomic_ops` | ||
| * Debian / Ubuntu: `sudo apt install libatomic1` | ||
| * Fedora: `sudo dnf install libatomic` | ||
|
|
||
| 1. Dont forget to add your user into dialout group "sudo usermod -aG dialout YOUR_USERNAME" for serial access |
There was a problem hiding this comment.
Is dialout the correct group in all distros?
Should we teach the user how to figure out the correct group by listing the contents of /dev?
There was a problem hiding this comment.
In Arch, it would be uucp ... but you'd expect an Archer to know that. dialout covers most cases.
|
|
||
| ## Building and running INAV Configurator locally (for development or Linux users) | ||
| ## Building and running INAV Configurator locally (for development) |
Corrected .rpm and .deb filenames
Altered the Linux installation instructions, from the perspective of a Linux n00b.