]> Chaos Git - corbenik/corbenik.git/commitdiff
Docs
authorchaoskagami <chaos.kagami@gmail.com>
Tue, 31 May 2016 12:47:03 +0000 (08:47 -0400)
committerchaoskagami <chaos.kagami@gmail.com>
Tue, 31 May 2016 12:47:03 +0000 (08:47 -0400)
README.md
doc/todo.md

index 1d32137d551d5c0e02aab2ad9c380de455365144..d2bd42f57f8c4877090686f6493a5b6e39971cd8 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,17 +1,32 @@
 Corbenik
 ==============================
 
-This is (yet another) CFW for the 3DS. Unlike other CFWs, this was mostly written from scratch and for fun - because I'm a control freak, and this carries quite a bit of OSDev and RE with it.
+## Oh god yet another rebrand of--
 
-Some parts are inherited from other CFW - for example, the firmware loading code in src/firm is based on Cakes, and sigpatch/firmprot/svcbackdoor were loosely based on Luma3DS.
+No. Definitely not.
 
-Eventually in operation, this will be most similar to Cakes out of the bunch. That is, it will use external patches from the filesystem and is intended for developers and control freaks. Unlike cakes, patches will be dynamically loaded binaries for arm9/arm11 which will be relocated against internal functions, allowing relatively tiny patches. This is not stable, and does not work yet.
+This is (yet another) CFW for the 3DS. Unlike other CFWs, this was mostly written from scratch and for fun. I'm a control freak, and this carries quite a bit of my mindset, and some OSDev and self-done RE with it.
 
-Rationale: I was initially going to make dynamic cakes, but I quickly realized a fatal flaw in any "patch" format: what you can do from a patch is limited to what the parser handles. The best way to fix is to simply externalize patches; e.g. even yifan lu suggested even that loader should use a bytecode VM.
+Some parts are inherited from other CFWs - e.g. the firmware loading code in src/firm is mostly based on Cakes, and sigpatch/firmprot/svcbackdoor were loosely based on Luma3DS's patches.
 
-If you want to know how Corbenik sizes up to other CFWs as of NOW - see `doc/features.md`. If you want to see how it will hopefully size up once I'm finished with all the code see `doc/intended-comparison.md`
+The *plan* at least is to be most similar to Cakes out of the bunch. That is, it will use external patches from the SD card's filesystem.
+
+Unlike cakes, patches will be some form of program, be it bytecode, a scripting language or dynamically loaded binaries. This is not yet implemented due to technical problems, but IS on the roadmap to get done as soon as I figure out *why* it isn't working. This code is located in a branch offline, due to the fact that it doesn't work.
+
+## Rationale
+
+I was initially going to make dynamic cakes, but I quickly realized a fatal flaw in any "patch" format: what you can do from a patch is limited to what the parser handles. This exact problem is why sempatches are used sometimes instead of classic diffs on the LKML, and it isn't a problem that will be solved without code. In my opinion, the best way to fix it is to simply externalize patches.
+
+## Comparison
+
+If you want to know how Corbenik sizes up to other CFWs as of NOW - see `doc/features.md`. I don't intend to sugarcoat - Corbenik is under development and is incomplete. There will be no stable release until a number of common features are implemented, and patches have been externalized.
+
+That said, feedback is welcome, but don't report anything obvious. Chances are I know, since Corbenik is my day-to-day CFW now.
 
 For compilation instructions, see `doc/compiling.md`.
 
-Unless otherwise noted, everything in this repo can be used under the terms of the GNU GPL, Version 3 or later (if ever) at your discretion. This includes situations where there's no copyright header within a source file. I get lazy with those; assume everything can be used under the GPL, or files were from GPLv2 or later (and thus are upgraded.)
-QoTD: "And I will tell you again...Welcome to 'The World.'"
+Unless otherwise noted, everything original in this repo can be used under the terms of the GNU GPLv2 or later. This includes situations where there's no copyright header within a source file. I get lazy with those; assume everything can be used under the GPL, or files were from software licensed GPLv2 or later (and thus are upgraded.) No source files within this repo bear questionable licenses.
+
+## Quote of the Day
+
+Welcome to "The World."
index 2655d5bd53d401a97b69d84f2d009d1409817511..bd9b92857d96b9c4203fce4c5cd135e57ab5bfb0 100644 (file)
@@ -2,6 +2,7 @@ Next
 -------------
 
  * Make config file for corbenik plaintext. Nobody likes binary configs. They suck. Massively. Especially when you fuck up a setting and need to change it on something that isn't a 3ds.
+ * In place firmware loading/patching.
 
 Shortterm
 -------------