8000 Improve README readability by froByte · Pull Request #639 · libffi/libffi · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Improve README readability #639

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Improve README readability #639

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f086d39
Improve README readability with markdown highlight
froByte Jun 9, 2021
d5b697f
Highlight keywords and links2
froByte Jun 9, 2021
f406c56
Update README.md
froByte Jun 27, 2021
2158e4a
from *"make"* to *make*
froByte Jul 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 17 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ Status
[![Build status](https://ci.appveyor.com/api/projects/status/8lko9vagbx4w2kxq?svg=true)](https://ci.appveyor.com/project/atgreen/libffi)

libffi-3.4 was released on TBD. Check the libffi web
page for updates: <URL:http://sourceware.org/libffi/>.
page for updates: [http://sourceware.org/libffi/](http://sourceware.org/libffi/).


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
convention*. The *calling convention* is essentially a set of
assumptions made by the compiler about where function arguments will
be found on entry to a function. A "calling convention" also specifies
be found on entry to a function. A *calling convention* also specifies
where the return value for a function is found.

Some programs may not know at the time of compilation what arguments
Expand All @@ -30,7 +30,7 @@ interface to various calling conventions. This allows a programmer to
call any function specified by a call interface description at run
time.

FFI stands for Foreign Function Interface. A foreign function
FFI stands for _Foreign Function Interface_. A foreign function
interface is the popular name for the interface that allows code
written in one language to call code written in another language. The
libffi library really only provides the lowest, machine dependent
Expand Down Expand Up @@ -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
distribution. Note that building libffi requires a C99 compatible
compiler.

If you're building libffi directly from git hosted sources, configure
won't exist yet; run ./autogen.sh first. This will require that you
install autoconf, automake and libtool.
won't exist yet; run `./autogen.sh` first. This will require that you
install `autoconf`, `automake` and `libtool`.

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not much difference. But i just thought it was most common to use single backticks in markdown


If you want to enable extra run-time debugging checks use the the
``--enable-debug`` configure switch. This is useful when your program dies
Expand Down Expand Up @@ -167,13 +167,13 @@ project's clang-cl compiler, like below:
path/to/configure CC="path/to/msvcc.sh -clang-cl" CXX="path/to/msvcc.sh -clang-cl" LD=link CPP="clang-cl -EP"

When building with MSVC under a MingW environment, you may need to
remove the line in configure that sets 'fix_srcfile_path' to a 'cygpath'
command. ('cygpath' is not present in MingW, and is not required when
remove the line in configure that sets `fix_srcfile_path` to a `cygpath`
command. (`cygpath` is not present in MingW, and is not required when
using MingW-style paths.)

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Now that I read this sentence again, it seems to be missing words. Should it be "must have"?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There was another rewrite of the readme that somebody submitted a few months ago. I never merged it. Did they rewrite this section?

`aarch64/Ffi_staticLib.sln`
required header files in `aarch64/aarch64_include/`


SPARC Solaris builds require the use of the GNU assembler and linker.
Expand All @@ -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
GNU make. You can ftp GNU make from [ftp.gnu.org:/pub/gnu/make](ftp.gnu.org:/pub/gnu/make) .

To ensure that libffi is working as advertised, type "make check".
To ensure that libffi is working as advertised, type `make check`.
This will require that you have DejaGNU installed.

To install the library and header files, type ``make install``.
Expand Down
0