Updated CONTRIBUTING.md #33
Conversation
Updated CONTRIBUTING.md file to include: * link to installation guide * grammar / contact me details * Added a screenshot for Mac gcc installation using Homebrew.
Updated CONTRIBUTING.md and added General Packages & Project Set up guide
Updated CONTRIBUTING.md, adding Stack installation guide.
Updated top section index: [Running Smooch on your computer](#run-smooch-on-your-computer)
|
Oh my this is looking amazing! I love the check list. It made me realize I forgot two dependencies: NetPBM: this is how the images are converted from the *.pnm format that LHA: this is the archive fomat that KiSS dolls use. Unfortunately, I can't remember where I found the program and got it to work -- it's so old! I'll figure it out and report back. Sorry this project is such a pain! I hope to simplify it over time! Thanks for your efforts!! |
* Removed outdate instructions in **Install cel2pnm** * Updated **Install stack** direction from `haskell` to `app`per [Issues emhoracek#23](emhoracek#23) * Added stack setup, stack build screenshots.
|
yay! Before I update the General Packages requirement, can you confirm if both NetPBM & LHA are already installed through stack build / stack set up? Or if I should add them as separate packages to install? Thanks Libby :) |
|
Unfortunately, both of these are separate packages that need installed separately. NetPBM is usually available via apt-get or other package repositories, so it's pretty easy to install. LHA may be harder. I originally downloaded it from here: http://freecode.com/projects/lhaforunix (Right-click save-as the button that say 1.17) Then I had to unzip the file, cd into the directory, and run |
Added **Install Netpbm** section.
|
Just added Install Netpbm section, do you want to merge this PR first? And we can continue the read on Issue #23 to resolve |
CONTRIBUTING.md
Outdated
|
|
||
| Next, run `stack build`. That will compile the Smooch app. | ||
| That will compile the Smooch app. |
There was a problem hiding this comment.
stack build is the part that compiles the Smooch app, rivet-autoimporter is just another dependency, a tool for migrating the database. So, I think the stack installl rivet-autoimporter step should go above the stack setup step so this sentence makes more sense.
| | ✔ | [GCC compiler](https://gcc.gnu.org/) | >= 7.2 | GCC is the compiler for [GNU operating system](http://www.gnu.org/gnu/thegnuproject.html), which includes C, C++, Objective-C, Fortran, Ada, and Go | | ||
| | ✔ | [stack](https://docs.haskellstack.org/en/stable/README/#the-haskell-tool-stack) | >= 1.5.1 | `stack` is a Haskell dependency management tool | | ||
| | ✔ | [Netpbm](http://brewformulas.org/Netpbm) | >= 10.73.14 | Netpbm is a toolkit for manipulation of graphic images, including conversion of images between a variety of different formats | | ||
| | | [Homebrew](https://brew.sh/) | >= 1.3.4 | Homebrew is the missing package manager for macOS | |
|
@lisaychuang Good idea! I went through and reviewed -- found one minor thing that it would be great if you could fix before I merge. (I didn't specify order when I asked you to add the autoimporter step, I know, my bad) |
Changed order of stack commands: `stack install rivet-autoimporter` before `stack build`.
|
Done! |
|
Thanks so much! I really appreciate the work you've done here, and other contributors will appreciate it too! Would you like commit access to the project? |
|
Yay! Will be an honor to get commit access, I'll love to see how this project grows :) |
Updated CONTRIBUTING.md file to include: