search

kiwi-bdd / Kiwi

Simple BDD for iOS
BSD 3-Clause "New" or "Revised" License
4.14k stars 512 forks source link

Getting Started Guide is over-complex, and out-of-date #626

Closed Drarok closed 8 years ago

Drarok commented 9 years ago

The goal is to provide a BDD library that is exquisitely simple to setup and use.

The getting started docs are not a simple guide, there's even quotes throughout saying "this part is tricky", "also tricky"!

I'm going to be frank. I have no idea what you are going to see here - depending on the Create Your Own Adventure path you used to get here, there may be one or several schemes listed here[…]

This does not fill me with confidence.

Also, the docs repeatedly state how to do something, then contradict this for Xcode 5 (and up, presumably). Xcode 5.0 was released on September 18, 2013, and Xcode 6 was released on September 17, 2014.

sharplet commented 9 years ago

I think you're exactly right! It's about time Kiwi's docs had a fresh overhaul.

Is this something you'd be interested in contributing?

Drarok commented 9 years ago

@sharplet: I can help with proofreading and testing out the steps to see if they work, but alas I am a terrible writer. Also, I don't know this project very well at all – I'm currently in the stages of mapping out what options there are for testing before choosing one.

sharplet commented 9 years ago

So I've just updated the readme to not point to the terrible instructions anymore: https://github.com/kiwi-bdd/Kiwi/commit/d291b7f4ccc13eca49a61ebe45d97592de2aed91.

modocache commented 8 years ago

Thanks for bringing this up, @Drarok, and thanks for the updates, @sharplet! If there are additional errors/improvements here, please feel free to open a pull request.