Skip to content
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.

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

Fix syntax errors in INSTALL.md #33

Merged
merged 1 commit into from
Dec 31, 2024
Merged
Changes from all commits
Commits
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
52 changes: 25 additions & 27 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,23 @@ package, you do not need to read this document.

For the impatient:

```shell
$ ./configure
$ make
$ make check
Gain root privileges
# make install
Drop root privileges
$ make installcheck
```
```shell
$ ./configure
$ make
$ make check
$ sudo make install # or `make install` with root privileges
$ make installcheck
```

Or alternatively, install as a regular user into your home directory:

```shell
$ ./configure --prefix ~/local
$ make
$ make check
$ make install
$ make installcheck
```
```shell
$ ./configure --prefix ~/local
$ make
$ make check
$ make install
$ make installcheck
```

# Dependencies

Expand Down Expand Up @@ -60,9 +58,9 @@ system. You will also need to do this if you modify `configure.ac`,
`Makefile.am`, or any of the other build system files. To do this, simply
run:

```shell
$ autoreconf -i -s
```
```shell
$ autoreconf -i -s
```

If ATF is installed in a different prefix than `autoconf`, you will also
need to tell `autoreconf` where the ATF m4 macros are located. Otherwise,
Expand All @@ -71,9 +69,9 @@ errors mentioning, for example, `ATF_CHECK_SH`. To fix this, you have
to run `autoreconf` in the following manner, replacing `<atf-prefix>` with
the appropriate path:

```shell
$ autoreconf -i -s -I <atf-prefix>/share/aclocal
```
```shell
$ autoreconf -i -s -I <atf-prefix>/share/aclocal
```

# General build procedure

Expand Down Expand Up @@ -103,14 +101,14 @@ To build and install the source package, you must follow these steps:

The most common, standard flags given to `configure` are:

## `--prefix=directory`
- `--prefix=directory`
- **Possible values**: any path
- **Default**: "/usr/local"

Specifies where the library (binaries and all associated files) will
be installed.

## `--help`
- `--help`
Shows information about all available flags and exits immediately,
without running any configuration tasks.

Expand Down Expand Up @@ -173,9 +171,9 @@ sources with support for ATF), you should periodically run the tests
from the final location to ensure things remain stable. Do so as
follows:

```shell
$ kyua test -k /usr/local/tests/lutok/Kyuafile
```
```shell
$ kyua test -k /usr/local/tests/lutok/Kyuafile
```

And if you see any tests fail, do not hesitate to report them in:

Expand Down