JuliaHubOSS / llvm-cbe

resurrected LLVM "C Backend", with improvements
Other
846 stars 146 forks source link

Readme update #74

Closed aminya closed 4 years ago

aminya commented 4 years ago

We should update the readme to show the latest status of the repository:

https://github.com/JuliaComputing/llvm-cbe/commit/9666d8b57ed631bc8d178d004761e30591a79dd2 is merged which makes it possible to skip the compiling of LLVM (which is impossible or very hard for most of the people), however, there is no section describing how to do it. I got in this trap of building LLVM and my computer was involved for a few days.

Once #65 and #73 are merged:

https://github.com/woachk/llvm-cbe/blob/fix-llvm9/README.md#L24

- llvm-cbe works with the LLVM 8.0 release version and autotools.
+ llvm-cbe works with the LLVM 10.0 release version and autotools.

https://github.com/woachk/llvm-cbe/blob/fix-llvm9/README.md#L10

- This version of the LLVM-CBE library works with LLVM 8.0. You will have
+ This version of the LLVM-CBE library works with LLVM 10.0. You will have

https://github.com/woachk/llvm-cbe/blob/fix-llvm9/README.md#L34

- git checkout release/8.x
+ git checkout release/10.x

https://github.com/JuliaComputing/llvm-cbe/blob/master/README.md#L68 It should changed to:

- $ $(HOME)/llvm/build/bin/llvm-cbe main.ll
+ $ $HOME/llvm-project/llvm/build/bin/llvm-cbe main.ll

https://github.com/woachk/llvm-cbe/blob/fix-llvm9/README.md#L75

- $ gcc -o main.cbe main.cbe.c
+ $ clang -o main.cbe main.cbe.c
woachk commented 4 years ago

Note that the LLVM 10 support PR does this more properly, with just mkdir build && cd build ; cmake .. being required, without defining USE_SYSTEM_LLVM.