Add screenshots to the CONTRIBUTING docs

[emhoracek]

Follow the directions in the CONTIBRUTING file to get Smooch running on your computer. Then take screenshots of each step and edit the file to include them. (It's easiest to do this in the Github UI.)

[lisaychuang]

Hi @emhoracek , I'm here for HacktoberFest and will like to work on this issue! Let me know if I can call dibs and get started =) Thanks! Lisa

[emhoracek]

@lisaychuang Awesome! Dibs are yours! Let me know if you run into any trouble at all -- get the Haskell stack up and running can be a little annoying so I may have missed some steps!

[emhoracek]

Actually, I just thought of a step I missed -- if you don't mind, could you add "Run stack install rivet-autoimporter" to the end of the Build Smooch section while you're making these other edits?

[lisaychuang]

Will do! I'll go through the steps and let you know if I bumped into any other issues /missed steps :)

[lisaychuang]

@emhoracek , I've updated the CONTRIBUTING.md guide installation in pull request #33 . But need your help/ clarification on the following:

• Install cel2pnm
  At the end of your original instructions, you ended with "Put cel2pnm in your PATH." - What does this mean? Do you mean for users to cd into the cel2pnm directory?

• Install stack
  You indicated: "Once you have stack installed, change to the haskell directory and run stack setup"

After installing stack, I could not find the haskell directory? This is as far as I can get based on the current installation guide...

thanks! Lisa

[emhoracek]

@lisaychuang Putting an executable in your $PATH means that your operating system knows where to find it and can execute it by name. This StackOverflow question has a pretty good explanation. This is important because when the app is running, it just uses the cel2pnm command. If you don't have cel2pnm in your PATH, then your operating system won't know where to find the program to run it.

$PATH is kinda hard to explain now that I think about it. Maybe I can make the app to work without needing to put cel2pnm in your $PATH. That might take some time, though. What's your operating system? I can go into more detail about how to make it work.

About the haskell directory -- sorry, it's the app directory now. Missed updating that part of the CONTRIBUTING file.

[lisaychuang]

Okay, so I've read up on $PATH and ended up on this Stackoverflow answer. I located the file by .~/profile , but am still not sure how I can add cel2pnm by editing the file. Tips?

P.S. updated the guide and changed haskell to app directory.

[emhoracek]

@lisaychuang I'm gonna assume you have OSX or Unix here -- correct me if I'm wrong --

There's a couple different ways to add it. In both, you're going to add a line like this:

export PATH=$PATH:cel2pnm_path

The question is what that cel2pnm_path is going to be. If you do a lot of development like this, it's a good idea to create a bin directory somewhere convenient, and put executables like this there. That way they're all in one place. If you do that, then your line will look like this:

export PATH=$PATH:$HOME/bin

and you'll just mv cel2pnm ~/bin to move cel2pnm to that directory.

The other possibility is to leave cel2pnm where it is, and just reference the current path in your profile. I put all my projects in a "dev" directory, for me it would look like this:

export PATH=$PATH:$HOME/dev/smooch/cel2pnm

Either way will work!

[lisaychuang]

I'll revisit this issue tomorrow - still need to update:

• Put cel2pnm in $PATH
• Wait for @emhoracek feedback on LHA installation /licensing

[huggablemonad]

For decompressing KiSS sets, I think lhasa is suitable for inclusion in Smooch. It's licensed under the ISC and is compatible with the GNU GPL. There's a Brew formula for it too. lhasa also has a shared library that could be used for Haskell bindings. I've not run into any problems with it so far.

[emhoracek]

@huggablemonad thanks -- I was leaning towards lhasa too but I haven't tested it yet.

@lisaychuang I'll give lhasa a try and let you know the steps to install it if it looks like a good option!

[lisaychuang]

@emhoracek sounds great! I'll loop back to this after your feedback, thanks Libby :)

[emhoracek]

@lisaychuang I tried out lhasa and it was really easy to install on Mac with brew: brew install lhasa. In Linux, it looks like you can sudo apt-get install lhasa as well. Seems to work just as well as the non-free lha for our purposes!

[aklap]

Just wanted to add that it would be really helpful to add @emhoracek's examples and comments to the setup section for adding cel2npm to your $PATH -- it's very clear and explicit as to what to do.

I could easily see the Stack Overflow page confusing someone with less experience editing their .bash_profile or working with the command line, since there are so many different answers there and not as much explanation about how they work or what to do.