Improve README readability #639
Conversation
- Make important keywords italic
- Links are now parsed as links
- Highlights some specific words (e.g lib names, and directories)
README.md
Outdated
|
|
||
|
|
||
| What is libffi? | ||
| =============== | ||
|
|
||
| Compilers for high level languages generate code that follow certain | ||
| conventions. These conventions are necessary, in part, for separate | ||
| compilation to work. One such convention is the "calling | ||
| convention". The "calling convention" is essentially a set of | ||
| compilation to work. One such convention is the *"calling |
There was a problem hiding this comment.
Maybe we should remove the double quotes.
README.md
Outdated
| @@ -127,17 +127,17 @@ Installing libffi | |||
|
|
|||
| First you must configure the distribution for your particular | |||
| system. Go to the directory you wish to build libffi in and run the | |||
| "configure" program found in the root directory of the libffi source | |||
| `"configure"` program found in the root directory of the libffi source | |||
There was a problem hiding this comment.
Again, please remove the double quotes.
|
|
||
| You may want to tell configure where to install the libffi library and | ||
| header files. To do that, use the ``--prefix`` configure switch. Libffi | ||
| will install under /usr/local by default. | ||
| will install under `/usr/local` by default. |
There was a problem hiding this comment.
I'm not a markdown expert, but I noticed that I used double backticks above for --prefix. What is the difference between single and double backticks?
There was a problem hiding this comment.
Not much difference. But i just thought it was most common to use single backticks in markdown
| To build static library for ARM64 with MSVC using visual studio solution, msvc_build folder have | ||
| aarch64/Ffi_staticLib.sln | ||
| required header files in aarch64/aarch64_include/ | ||
| To build static library for ARM64 with MSVC using visual studio solution, *msvc_build* folder have |
There was a problem hiding this comment.
Now that I read this sentence again, it seems to be missing words. Should it be "must have"?
There was a problem hiding this comment.
There was another rewrite of the readme that somebody submitted a few months ago. I never merged it. Did they rewrite this section?
README.md
Outdated
| @@ -184,10 +184,10 @@ For iOS builds, the ``libffi.xcodeproj`` Xcode project is available. | |||
|
|
|||
| Configure has many other options. Use ``configure --help`` to see them all. | |||
|
|
|||
| Once configure has finished, type "make". Note that you must be using | |||
| GNU make. You can ftp GNU make from ftp.gnu.org:/pub/gnu/make . | |||
| Once configure has finished, type *"make"*. Note that you must be using | |||
There was a problem hiding this comment.
Maybe make or make, but probably not "make". What makes more sense?