Skip to content

Commit 95ce75e

Browse files
authored
Update README.md (improvement)
code block syntax fix. (improvement)
1 parent 47dbfa2 commit 95ce75e

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

README.md

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,11 @@ After installation, _the application must be launched at least once to allow the
4444
Head over to the [releases](https://github.com/sbarex/SourceCodeSyntaxHighlight/releases) page to view the latest version. Move `Syntax Highlight.app` into the `Applications` folder.
4545

4646
### Install with Homebrew Cask
47-
Syntax Highlight can also be installed via [Homebrew Cask](https://github.com/Homebrew/homebrew-cask). If you have not installed Homebrew, follow the simple instructions [here](https://brew.sh/). After that, run `brew install --cask --no-quarantine syntax-highlight` to install the current version of Syntax Highlight.
47+
Syntax Highlight can also be installed via [Homebrew Cask](https://github.com/Homebrew/homebrew-cask). If you have not installed Homebrew, follow the simple instructions [here](https://brew.sh/). After that, install the current version of Syntax Highlight with the following command:
48+
49+
```bash
50+
brew install --cask --no-quarantine syntax-highlight
51+
```
4852

4953
### Note for the precompiled release
5054
The [precompiled app](https://github.com/sbarex/SourceCodeSyntaxHighlight/releases) is not notarized or signed, so the first time you run the app the system may show a warning about the impossibility to check for malicious software.
@@ -53,8 +57,8 @@ To fix, you can launch the app with right-click (or Control-click) on the app ic
5357

5458
You can also execute this command from the terminal:
5559

56-
```
57-
$ xattr -r -d com.apple.quarantine "FULL PATH OF Syntax Highlight.app (you can drag the file to get the pull path)"
60+
```bash
61+
xattr -r -d com.apple.quarantine "FULL PATH OF Syntax Highlight.app (you can drag the file to get the pull path)"
5862
```
5963

6064
Alternatively, after trying to launch the app for the first time, you can open the `System Preferences > Security & Privacy > General (tab)` and click the `Open Anyway` button.
@@ -67,9 +71,12 @@ The release application is compiled as a universal binary (Intel and Apple silic
6771

6872
After cloning remember to fetch submodules:
6973

74+
```bash
75+
git submodule init
7076
```
71-
$ git submodule init
72-
$ git submodule update
77+
78+
```bash
79+
git submodule update
7380
```
7481

7582
## Enable the Quick Look extension
@@ -389,8 +396,8 @@ With the _Inquiry window_ you can see if a specific file type is handled by the
389396

390397
Alternatively you can see the UTI of a file with this Terminal command:
391398

392-
```
393-
$ mdls -name kMDItemContentType -name kMDItemContentTypeTree filename.ext
399+
```bash
400+
mdls -name kMDItemContentType -name kMDItemContentTypeTree filename.ext
394401
```
395402

396403
It's likely that I didn't associate all the possible extensions managed by `highlight`.
@@ -407,8 +414,8 @@ The tool is located inside the `Syntax Highlight.app/Contents/Resources` folder
407414

408415
From the Application menu you can create a symbolic link into `/usr/local/bin` folder.
409416

410-
```sh
411-
$ /Application/Syntax\ Highlight.app/Contents/Resources/syntax_highlight_cli -h
417+
```bash
418+
/Application/Syntax\ Highlight.app/Contents/Resources/syntax_highlight_cli -h
412419
```
413420
```
414421
Usage: syntax_highlight_cli [-o <path>] <file> [..]
@@ -502,7 +509,7 @@ The command line tool require macOS 10.15.4 or later.
502509
> It depends… first the format must be handled by `highlight`. Check in the _Inquiry window_ if the file is supported.
503510
> If is supported please send me the UTI associated to the file. You can also view the UTI with this terminal command:
504511
>
505-
> `$ mdls -name kMDItemContentType -name kMDItemContentTypeTree filename.ext`
512+
> `mdls -name kMDItemContentType -name kMDItemContentTypeTree filename.ext`
506513
>
507514
> Some common files cannot be handled by third party extension because are reserved by the system (for example, `.ts`, `.html`, …).
508515
>
@@ -606,18 +613,19 @@ The application embed the [`Highlight`](http://www.andre-simon.de/doku/highlight
606613
607614
- https://stackoverflow.com/questions/16943819/where-do-uti-come-from/18014903#18014903
608615
> List all registered UTIs:
609-
> ```sh
616+
> ```bash
610617
> /System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/Support/lsregister -dump
611618
> ```
612619
613620
- handle extension from command line (https://stackoverflow.com/questions/66546696/how-to-enable-and-debug-a-macos-file-provider-extension , https://stackoverflow.com/questions/34898903/what-do-the-prefixes-in-the-output-of-macos-pluginkit-mean/36839118#36839118 , https://kevin.deldycke.com/2019/07/macos-commands/ ):
614-
```sh
615-
# list all registered quicklook plugins:
616-
pluginkit -mAvvv -p com.apple.quicklook.preview
617621
618-
# info about a plugin:
622+
List all registered quicklook plugins:
623+
```bash
624+
pluginkit -mAvvv -p com.apple.quicklook.preview
625+
```
626+
İnfo about a plugin:
627+
```bash
619628
pluginkit -m -v -i org.sbarex.SourceCodeSyntaxHighlight.QuicklookExtension --raw
620-
621629
```
622630

623631
## Credits

0 commit comments

Comments
 (0)