KJCracks / Clutch

Fast iOS executable dumper
3.71k stars 646 forks source link

Update the Wiki #119

Open NinjaLikesCheez opened 8 years ago

NinjaLikesCheez commented 8 years ago

Hi,

Clutch Wiki is way out of date, so I'm going to spend some time updating it (can't do much at a time, but slowly it'll get better hopefully!). So, what are some topics that should be in the wiki? I'm thinking these kind of things:

Any input (even just topic ideas, you don't have to write the page) is appreciated, thanks. 😊

Tatsh commented 8 years ago

I think it's way better to just keep this in sections in README.md. I can just cat the README out and read it on my computer instead of having to get to the repository page.

I see that the Wiki says to use xcodebuild but cd Clutch && make is a lot shorter, and very easy to modify. Requires absolutely no opening of Xcode to change settings. Useful if you are SSH'ing in to your Mac and have no GUI

Is the Swap Swap Attack page still accurate?

NinjaLikesCheez commented 8 years ago

Ok, I can do both that way if users go to either they'll find the updated information too.

I'll delete those pages too (I believe that config and scripting aren't even in the codebase anymore anyway) and add the disclaimer.

It's not, I think this page should be updated to explain what a swap-swap attack is, and why.

Tatsh commented 8 years ago

Thinking about it again I think the Readme should just have build instructions, usage, disclaimer, maybe FAQ.

Everything else can go in the Wiki.

Maybe there is a tool that can auto convert and sync (via GitHub API). That way full documentation can be distributed in a package along with an up-to-date manpage, all from a single source for documentation.

NinjaLikesCheez commented 8 years ago

I believe you can clone git@github.com:KJCracks/Clutch.wiki.git and edit things that way - but I'll look into if theres a tool that can do this better.

Deco354 commented 8 years ago

I couldn't clone through ssh, I got the following error:

Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

https worked a charm though. Might be worth updating the Readme if this isn't unique to myself. git clone https://github.com:KJCracks/Clutch.git