From 161be962b47336c18c37c7a17bb57f2efa0b0123 Mon Sep 17 00:00:00 2001 From: Lightmann Date: Fri, 24 Nov 2023 11:54:05 -0500 Subject: [PATCH 1/2] Document Prefix.pch changes/functionality --- docs/Features.md | 3 --- docs/Structure.md | 3 ++- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/Features.md b/docs/Features.md index 2123b16..87fdf5f 100644 --- a/docs/Features.md +++ b/docs/Features.md @@ -7,9 +7,6 @@ Below is a list of undocumented features implemented since the [original Theos]( *(To do: These features should be properly documented and this file removed.)* -* Provides `IS_IPAD` and `IN_SPRINGBOARD` macros in the prefix header. (kirb) * Imports Cocoa and AppKit when targeting OS X. (kirb) * Adds `simbltweak.mk` to help in the building of SIMBL tweaks for OS X. (kirb) -* Allows `int argc, char **argv, char **envp` arguments to be utilised in `%ctor` and `%dtor`. (uroboro) -* Adds backwards compatibility for [nullability](https://developer.apple.com/swift/blog/?id=25) keywords when building with older versions of clang that don’t support it. (kirb) * Building for iOS Simulator now disables linking Substrate by default, allows linking against OS X binaries, and builds for only x86_64 by default (rather than both i386 and x86_64) when building for iOS 8.0 or newer. (kirb) diff --git a/docs/Structure.md b/docs/Structure.md index 0eed004..009a987 100644 --- a/docs/Structure.md +++ b/docs/Structure.md @@ -27,4 +27,5 @@ Information regarding the various parts of Theos' internal structure: * **logos/**: The files for [Logos](https://github.com/theos/logos). * **nic/**: The files for [NIC](/docs/NIC.html). * **templates/**: [Built-in templates](https://github.com/theos/templates) that may be used to scaffold new projects using [NIC](/docs/NIC.html). -* **Prefix.pch**: The prefix header imported into the compilation process for all C-based languages. Provides macros and imports of frameworks for legacy projects. +* **Prefix.pch**: The prefix header imported into the compilation process for all C-based languages targeting iOS. Provides convenient [macros](https://github.com/theos/headers/blob/master/theos/IOSMacros.h), backwards compatibility for [nullability](https://github.com/theos/headers/blob/master/theos/BackwardsCompat.h), and imports of [common frameworks](https://github.com/theos/theos/blob/master/Prefix.pch) for legacy projects. + * Deprecated and non-functional for macOS and tvOS, iOS when taregting iOS 14+, and Swift. From bcadb078e20472d6ba0b6acebaff2e4f5d10782b Mon Sep 17 00:00:00 2001 From: Lightmann Date: Fri, 24 Nov 2023 12:05:03 -0500 Subject: [PATCH 2/2] Create SIMBL.md and delete Features.md --- _data/docs_sidebar.yaml | 3 ++- docs/Features.md | 12 ------------ docs/SIMBL.md | 9 +++++++++ 3 files changed, 11 insertions(+), 13 deletions(-) delete mode 100644 docs/Features.md create mode 100644 docs/SIMBL.md diff --git a/_data/docs_sidebar.yaml b/_data/docs_sidebar.yaml index 5b73f9a..7aeed0b 100644 --- a/_data/docs_sidebar.yaml +++ b/_data/docs_sidebar.yaml @@ -23,7 +23,6 @@ link: /docs/Packaging.html - title: Features - link: /docs/Features.html list: - title: NIC link: /docs/NIC.html @@ -50,6 +49,8 @@ link: https://orion.theos.dev/ - title: Rootless link: /docs/Rootless.html + - title: SIMBL + link: /docs/SIMBL.html - title: Technical list: diff --git a/docs/Features.md b/docs/Features.md deleted file mode 100644 index 87fdf5f..0000000 --- a/docs/Features.md +++ /dev/null @@ -1,12 +0,0 @@ ---- -title: Features -layout: docs ---- - -Below is a list of undocumented features implemented since the [original Theos](https://github.com/theos/theos/tree/legacy) by Dustin Howett. Said features are sorted in ascending order by their implementation date (where the latest additions are at the bottom). - -*(To do: These features should be properly documented and this file removed.)* - -* Imports Cocoa and AppKit when targeting OS X. (kirb) -* Adds `simbltweak.mk` to help in the building of SIMBL tweaks for OS X. (kirb) -* Building for iOS Simulator now disables linking Substrate by default, allows linking against OS X binaries, and builds for only x86_64 by default (rather than both i386 and x86_64) when building for iOS 8.0 or newer. (kirb) diff --git a/docs/SIMBL.md b/docs/SIMBL.md new file mode 100644 index 0000000..4510689 --- /dev/null +++ b/docs/SIMBL.md @@ -0,0 +1,9 @@ +--- +title: SIMBL +layout: docs +--- + +*TODO: Document Theos' SIMBL (simbltweak.mk) support* + +[MySIMBL](https://github.com/w0lfschild/mySIMBL)-/[MacForge](https://github.com/MacEnhance/MacForge)-based tweaks for OSX. +