Skip to content

Commit b15f5b5

Browse files
committed
README: a couple more markdown fixups
1 parent 963d7d9 commit b15f5b5

File tree

1 file changed

+17
-18
lines changed

1 file changed

+17
-18
lines changed

README.md

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ AnyKernel2 pushes the format even further by allowing kernel developers to modif
1010
A working script based on DirtyV Kernel for Galaxy Nexus (tuna) is included for reference.
1111

1212
## // Properties / Variables ##
13-
```bash
13+
```
1414
kernel.string=KernelName by YourName @ xda-developers
1515
do.devicecheck=1
1616
do.initd=1
@@ -20,19 +20,18 @@ device.name1=maguro
2020
device.name2=toro
2121
device.name3=toroplus
2222
block=/dev/block/platform/omap/omap_hsmmc.0/by-name/boot;
23+
```
2324

24-
do.devicecheck=1 specified requires at least device.name1 to be present. This should match ro.product.device or ro.build.product for your device. There is support for up to 5 device.name# properties.
25+
__do.devicecheck=1__ specified requires at least device.name1 to be present. This should match ro.product.device or ro.build.product for your device. There is support for up to 5 device.name# properties.
2526

26-
do.initd=1 will create the init.d directory in /system/etc/init.d/ and apply 755 permissions.
27+
__do.initd=1__ will create the init.d directory in /system/etc/init.d/ and apply 755 permissions.
2728

28-
do.modules=1 will push the contents of the module directory to /system/lib/modules/ and apply 644 permissions.
29+
__do.modules=1__ will push the contents of the module directory to /system/lib/modules/ and apply 644 permissions.
2930

30-
do.cleanup=0 will keep the zip from removing it's working directory in /tmp/anykernel - this can be useful if trying to debug in adb shell whether the patches worked correctly.
31-
```
31+
__do.cleanup=0__ will keep the zip from removing it's working directory in /tmp/anykernel - this can be useful if trying to debug in adb shell whether the patches worked correctly.
3232

3333
## // Command Methods ##
34-
35-
```bash
34+
```
3635
dump_boot
3736
backup_file <file>
3837
replace_string <file> <if search string> <original string> <replacement string>
@@ -49,27 +48,27 @@ patch_fstab <fstab file> <mount match name> <fs match type> <block|mount|fstype|
4948
write_boot
5049
```
5150

52-
"if search string" is the string it looks for to decide whether it needs to add the tweak or not, so generally something to indicate the tweak already exists.
51+
__"if search string"__ is the string it looks for to decide whether it needs to add the tweak or not, so generally something to indicate the tweak already exists.
5352

54-
Similarly, "line match string" and "line replace string" are the search strings that locate where the modification needs to be made for those commands, "begin search string" and "end search string" are both required to select the first and last lines of the script block to be replaced for replace_section, and "mount match name" and "fs match type" are both required to narrow the patch_fstab command down to the correct entry.
53+
Similarly, __"line match string"__ and __"line replace string"__ are the search strings that locate where the modification needs to be made for those commands, __"begin search string"__ and __"end search string"__ are both required to select the first and last lines of the script block to be replaced for replace_section, and __"mount match name"__ and __"fs match type"__ are both required to narrow the _patch_fstab_ command down to the correct entry.
5554

56-
"before|after" requires you simply specify "before" or "after" for the placement of the inserted line, in relation to "line match string".
55+
__"before|after"__ requires you simply specify __"before"__ or __"after"__ for the placement of the inserted line, in relation to __"line match string"__.
5756

58-
"block|mount|fstype|options|flags" requires you specify which part (listed in order) of the fstab entry you want to check and alter.
57+
__"block|mount|fstype|options|flags"__ requires you specify which part (listed in order) of the fstab entry you want to check and alter.
5958

60-
You may also use ui_print "<text>" to write messages back to the recovery during the modification process, and contains "<string>" "<substring>" to simplify string testing logic you might want in your script.
59+
You may also use _ui_print "\<text\>"_ to write messages back to the recovery during the modification process, and _contains "\<string\>" "\<substring\>"_ to simplify string testing logic you might want in your script.
6160

6261
## // Instructions ##
6362

64-
1- Place zImage in the root (dtb should also go here for devices that require a custom one, both will fallback to the original if not included)
63+
1. Place zImage in the root (dtb should also go here for devices that require a custom one, both will fallback to the original if not included)
6564

66-
2- Place any required ramdisk files in /ramdisk
65+
2. Place any required ramdisk files in /ramdisk
6766

68-
3- Place any required patch files (generally partial files which go with commands) in /patch
67+
3. Place any required patch files (generally partial files which go with commands) in /patch
6968

70-
4- Modify the anykernel.sh to add your kernel's name, boot partition location, permissions for included ramdisk files, and use methods for any required ramdisk modifications
69+
4. Modify the anykernel.sh to add your kernel's name, boot partition location, permissions for included ramdisk files, and use methods for any required ramdisk modifications
7170

72-
5- zip -r9 UPDATE-AnyKernel2.zip * -x README UPDATE-AnyKernel2.zip
71+
5. zip -r9 UPDATE-AnyKernel2.zip * -x README UPDATE-AnyKernel2.zip
7372

7473
If supporting a recovery that forces zip signature verification (like Cyanogen Recovery) then you will need to also sign your zip using the method I describe here:
7574

0 commit comments

Comments
 (0)