diff --git a/README.md b/README.md index 34592949..f04c6de1 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Remove jit overhead from your package and compile it into a system image. -## Usage Example +## Usage example E.g. do: ```Julia using PackageCompiler @@ -22,14 +22,14 @@ PackageCompiler.compile_package("Matcha", "UnicodeFun", force = false, reuse = t # You can define a file that will get run for snooping explicitely like this: # this makes sure, that binary gets cached for all functions called in `for_snooping.jl` -PackageCompiler.compie_package(("Matcha", "relative/path/for_snooping.jl")) +PackageCompiler.compile_package("Matcha", "relative/path/for_snooping.jl") # if you used force and want your old system image back (force will overwrite the default system image Julia uses) you can run: PackageCompiler.revert() ``` -## Trouble shooting: +## Troubleshooting: - You might need to tweak your runtest, since SnoopCompile can have problems with some statements. Please open issues about concrete problems! This is also why there is a way to point to a file different from runtests.jl, for the case it becomes impossible to combine testing and snoop compiling (just pass `("package", "snoopfile.jl")`)!