Test install instructions and revise for clarity

[brittag]

Since this is a neat simple tool, it'd be nice to have the install instructions fixed up so that anyone can set this up for their own use even if they don't have a lot of background knowledge. This is a task anyone can work on (inside or outside 18F) - could even be especially helpful for a non-18F person to test it.

More explanation: try setting this up and using it, note any problems or confusing parts you run into, either fix them in the readme (if you know how) or note them as an issue, and generally revise the instructions for clarity. For example, link to explanations for how to set up Python and virtualenv (for example if people don't want to run the whole laptop script) and how to clone the repository. Maybe move the Slack API key setup instructions into the "Installation" section, if that makes more sense to you. You could also link to the relevant blog post and add other examples of interesting uses.

[IanLee1521]

You may want to consider collapsing all of the installation instructions down to the simple pip install slack-emoji-search command and doing away with most of the README. @brittag mentioned needing to look at how to make use of PyPI to distribute the packages though, so maybe you're not quite there?

The benefit is that at that point, you can simply do:

pip install slack-emoji-search
emoji_search --api-token=ABCXYZ ...

With out needing to worry about the executable binary, pathing, writing extra files, etc. Which I suspect is much more the way that users are going to want to use this tool. But I may be wrong.

[IanLee1521]

See IanLee1521@0b513cf for a possible implementation of what I'm thinking would be a simpler cleaner installation / usage.

[brittag]

Thanks for the suggestion! I think you're right that most people will go for the pip install if they want to get this tool installed. Having both the simple "do the steps for me" instructions and the step-by-step instructions seems nice for resilience and reuse though - for example people might find the step-by-step instructions helpful if they're forking and adapting the code for a different purpose.

[IanLee1521]

Hmm. That's a good point. Let me iterate on it and see if I can add something reasonable. Thanks!