<html><head></head><body>I thought about suggesting this myself, some time ago.<br>
<br>
I think it's not a bad idea to encourage maintainers to provide an example in the README too, just for the user's convenience.<br><br><div class="gmail_quote">On 18 May 2018 5:21:56 PM NZST, B Watson <yalhcru@gmail.com> wrote:<blockquote class="gmail_quote" style="margin: 0pt 0pt 0pt 0.8ex; border-left: 1px solid rgb(204, 204, 204); padding-left: 1ex;">
<pre class="k9mail">Got an email from a new user... he had read the README for the build he<br>was trying to run, and it said to set an environment variable... being<br>completely new to *nix, he didn't know how to do that.<br><br>Would it hurt to add some text to the HOWTO page explaining this? I<br>know it's pretty elementary stuff, but the HOWTO already details how to<br>extract a tarball and launch a shell script from the current directory,<br>which are also elementary tasks...<br><br>Proposed text to add to the end of "Step 2 - Read the README":<br><br>---cut-here---<br>If the README mentions any options controlled by environment variables,<br>you can set these options now by running:<br><br> export VARIABLE=value<br><br>For instance, if the README says you can build against SDL 2.0 by setting<br>SDL2=yes in the environment, you would type:<br><br> export SDL2=yes<br><br>If there are multiple options, you can use multiple export commands.<br><br>If you're unsure, don't set any variables here. In most cases, the<br>SlackBuild maintainer has made the default behaviour (no options) the<br>most common or most useful way to build the package.<br>---cut-here---<br><br>...yes, it's possible (and "cleaner") to just say SDL2=yes<br>./whatever.SlackBuild in Step 4, but the way the howto is split up<br>into steps, it would make less sense for step 4 to effectively say "Oh,<br>by the way, you should have noticed if there were environment variable<br>options in step 2". So Step 2 has to mention them, since that's where<br>they're visible.<br><br>Thoughts?<br><hr><br>SlackBuilds-users mailing list<br>SlackBuilds-users@slackbuilds.org<br><a href="https://lists.slackbuilds.org/mailman/listinfo/slackbuilds-users">https://lists.slackbuilds.org/mailman/listinfo/slackbuilds-users</a><br>Archives - <a href="https://lists.slackbuilds.org/pipermail/slackbuilds-users/">https://lists.slackbuilds.org/pipermail/slackbuilds-users/</a><br>FAQ - <a href="https://slackbuilds.org/faq/">https://slackbuilds.org/faq/</a><br><br></pre></blockquote></div><br>
-- <br>
Klaatu</body></html>