Skip to content

Commit

Permalink
clarify README
Browse files Browse the repository at this point in the history
  • Loading branch information
ilia-kats committed Jul 31, 2021
1 parent afd9e68 commit 6762c98
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ The output is still valid Julia code.
## Emojify your code
You can use either a string with Julia code as input, or a file path.
If a file path is given, all files referenced with `include()` will also be emojified.
If your code defines modules, module names, names of exported functions, and keyword arguments of exported functions will not be emojified.

For example,
```julia
Expand Down Expand Up @@ -44,5 +45,5 @@ You can also pass a `Vector{Char}` as the last argument to use instead of the de
emojify("path_to_input_file.jl", "path_to_output_directory", Char.(0x02107:0x0214A))
```

## Emojifying base Julia functions
## Emojifying calls base Julia functions
To achieve absolute chaos, I recommend using this package together with [WatchJuliaBurn.jl](https://github.com/theogf/WatchJuliaBurn.jl).

0 comments on commit 6762c98

Please sign in to comment.