Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

Commit

Permalink
Clean and Tidy READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
Naville committed Mar 7, 2016
1 parent 6ffdc4f commit 609a116
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 16 deletions.
24 changes: 22 additions & 2 deletions HackingGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,8 @@ Also.There is a init_XXX_hook function inside each module,which XXX in your modu

The main tweak will call that to init your hook.Check below for details

###Names
####For Modules.
####Names
#####For Modules.
All these must be the same.

1. Module File Name
Expand All @@ -35,6 +35,14 @@ All these must be the same.
**Read ThirdPartyTools/README.md for detailed info **


####Prototype Codes
Some codes, you might not want to expose them directly. Either because they have bugs, or, they are incomplete.

Put These Codes Inside **#ifdef PROTOTYPE** and **#endif**

These codes will be enabled only when PROTOTYPE Flag for build.py is *Implicitly* turned on.(See Below)


####Custom Preferences
Add Your Own Preferences in **Preferences/** With Filename **MODULENAME.plist**

Expand Down Expand Up @@ -63,6 +71,18 @@ Please Note:
4. Don't add semicolon to WTCallBack
5. Only One Set Of **dyld CallBack** Marcos Can Be Called In A Module

####Building
You Probably Need The Latest Substrate Header. Check [Issues#1](https://github.com/Naville/WTFJH/issues/1) In Case Something Went Wrong.

Usually. Simple run **./build.py** is enough
Other Arguments(Upper/Lower Case Doesn't Matter):

1. DEBUG. Show Compiling Info Inside Terminal. When Not Set. Logs Are Saved In **MainLog.log** and **ThirdPartyLog.log**
2. OBFUSCATION OBFUSCATION SYMBOLS (NOT ALL. NEED CONTRIBUTIONS)
3. PROTOTYPE *Enable Codes Flagged As Prototype*



####Misc
Some functions don't come with the binary and you'll have to wait the related library to be loaded

Expand Down
22 changes: 8 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,20 @@
# What The Fuck Just Happened
> A Modern Replacement For IntroSpy [iSECPartners/Introspy-iOS][1]
> Feel Free To Send Us Pull Requests. It's a project too big for two part-time developers
> Feel Free To Send Us Pull Requests.
> Infrastructural Codes Are Copied (And Modified) From IntroSpy Project And My Own MinusBlock Project [Naville/MinusBlock][2] To Save Time.
> It's a project too big for two part-time developers
> *VERSION* is meant to be there for package version consistency's sake. Also make VERSION changes easy-trackable by reviewing history of **VERSION**
> Infrastructural Codes Are Copied (And Modified) From IntroSpy Project And My Own MinusBlock Project [Naville/MinusBlock][2] To Save Time.
# Usage
> ./Template.py (SDK|API) ModuleName
for Generating a new Template
>Probably Need A substrate.h on device if you encounter compile errors
> ./build.py FOR BUILDING
- DEBUG For Displaying Building Logs (When It's Not Set. Logs are saved in *.log in Project Root)
- PROTOTYPE For Enabling Prototype Codes
- OBFUSCATION For Obfuscating The Tweak
> *VERSION* is meant to be there for package version consistency's sake
> Write Prototype Code Between *\#ifdef PROTOTYPE* and *\#endif*
> Also make VERSION changes easy-trackable by reviewing history of **VERSION**
> SignatureDatabase.plist is the code signature database we'll use to defeat Method/Name Obfuscations. Detailed Structs are to be determined
# Usage
>Standard User: *./build.py*
Read *Preferences/README.md* for more info
>HackingGuide.md Contains Detailed Explanation
# TODOs
- Merge [https://github.com/BishopFox/iSpy][3] into WTFJH
Expand Down

0 comments on commit 609a116

Please sign in to comment.