Commit graph

37 commits

Author SHA1 Message Date
Daniel Eklöf
7c686208a1
meson: add -Ddocs=disabled|enabled|auto command line option
When enabled (the default, if scdoc is found), we build and install
the man pages, example foot.ini, readme, changelog and license files.
2021-07-24 13:12:10 +02:00
Daniel Eklöf
4a6dea04c2
install: add -Dgrapheme-clustering to the list of custom meson options 2021-06-24 17:57:34 +02:00
Daniel Eklöf
501548080d
install: add the new ‘terminfo-install-location’ option
And flesh out the description of the ‘terminfo’ option, and how it
relates to the new ‘terminfo-install-location’.

Also add instructions on how to manually generate the terminfo files.
2021-06-23 17:04:12 +02:00
Daniel Martí
8ae8635add INSTALL: fix an unclosed markdown quote
While skimming this doc, I noticed that "-Dterminfo" wasn't rendering
properly as it was lacking its closing backquote.

While at it, tweak the Arch wiki link, as it redirects to replace
/index.php with /title.
2021-05-13 09:49:38 +01:00
Daniel Eklöf
a88a86f797
install: add ‘ninja test’ to all build types
While we don’t (yet) have any unit tests for foot, users can build
foot with e.g. fcft and/or tllist as sub-projects. *They* have tests,
and when doing PGO builds, those test binaries *must* be executed, or
we get link failures in the final build.
2021-03-28 17:24:35 +02:00
Daniel Eklöf
3fd9256c02
install: clang-11.x compatible PGO instructions
LLVM/Clang 11.x throws errors for _files_ without any profiling data:

  error: ../../async.c: Function control flow change detected (hash mismatch) async_write Hash = 72057641800614222 [-Werror,-Wbackend-plugin]

This caused multiple issues with the current PGO instructions:

* The `pgo` binary failed to link with `meson configure -Db_pgo=use`
  when doing a full PGO build (since it isn't used in this case);
* `footclient` fails to link for the same reason.
* `foot` fails to link for the same reason in **partial** PGO builds.

The solution is to make sure all binaries that are built in the final
phase (`-Db_pgo=use`) have been executed in the _generate_ phase.

Doing this also means we can drop `-Wno-missing-profile` and friends.

Also add `--sixel` to the `generate-alt-random-writes` command line in
the description for a full PGO build.

Closes #418
2021-03-26 22:16:55 +01:00
Daniel Eklöf
243578d308
install: add ‘llvm’ as an optional build dependency
It is needed for PGO builds with Clang.
2021-03-26 22:16:54 +01:00
Simon Schricker
b169623b64
Add: Bash completion for foot and footclient
* use toe for terminfo, thanks Craig.
* adds optional dependency on bash-completion for positional arguments

Co-authored-by: Craig Barnes <craigbarnes@protonmail.com>
2021-03-17 13:10:28 +01:00
Daniel Eklöf
4ff07a0d18
install: add libnotify and xdg-utils as optional dependencies 2021-02-14 12:10:38 +01:00
Daniel Eklöf
3d71b74442
install: add -Dterminfo to list of compile-time options 2021-02-09 19:46:06 +01:00
Daniel Eklöf
aa13dfb4e8
install: remove -march=native
This simplifies the instructions. People interested in performance are
likely to know how to use it.
2020-12-21 13:01:38 +01:00
Daniel Eklöf
4fe95e6354
install.md: mention that packagers should not use -march=native 2020-12-21 12:24:47 +01:00
Daniel Eklöf
5a1dcbb04d
install.md: add -Wno-profile-instr-unprofiled to clang flags in PGO builds 2020-12-21 12:24:29 +01:00
Daniel Eklöf
288ea360cb
install: fix typo in ‘ninja’ 2020-12-21 12:15:59 +01:00
Craig Barnes
013cca646d meson: use wrap files for fcft/tllist subprojects
See: https://mesonbuild.com/Wrap-dependency-system-manual.html
2020-12-19 22:43:09 +00:00
Daniel Eklöf
6494ba24c9
install: simplify sentence 2020-12-08 19:19:09 +01:00
Daniel Eklöf
fe6cf547f1
install: highlight option default value in options list 2020-12-07 20:44:12 +01:00
Daniel Eklöf
ab699338b3
install: highlight option name in options list 2020-12-07 20:44:12 +01:00
Daniel Eklöf
559c87b84a
install: add ‘options’ section, describing compile-time options 2020-12-07 20:44:12 +01:00
Daniel Eklöf
7755af5bea
install: add --sixel to suggested command line for generate-alt-random-writes 2020-11-24 21:31:44 +01:00
Daniel Eklöf
24164101b3
install: minor tweaks to PGO instructions 2020-11-22 19:29:45 +01:00
Daniel Eklöf
6214cdeaf1
install: re-write release build instructions 2020-11-22 19:29:44 +01:00
Daniel Eklöf
af6d1aa522
install: re-write description of recommended flags, and add size comparison 2020-11-22 19:29:44 +01:00
Daniel Eklöf
82a9097cc0
install: no need to run input *that* many times 2020-11-22 19:29:44 +01:00
Daniel Eklöf
f75ff86fc0
install: add --attr-{bold,italic,underline} to generate-alt-random-writes 2020-11-22 19:29:43 +01:00
Daniel Eklöf
e1bde0b0e7
remove pre-generated input corpus for PGO 2020-11-22 19:29:43 +01:00
Daniel Eklöf
e248f58ff6
install: add --colors-256 to generate-alt-random-writes 2020-11-22 19:29:42 +01:00
Daniel Eklöf
84b24d34d2
install: small rewording and restructuring of PGO instructions 2020-11-22 19:28:55 +01:00
Daniel Eklöf
27f3ca1255
install: update PGO instructions 2020-11-22 19:28:54 +01:00
Daniel Eklöf
11ea06c71d
install: simplify sentence 2020-11-14 14:12:22 +01:00
Daniel Eklöf
fb32d339a7
install: remove -fno-plt from recommended CFLAGS
It appears to _worsen_ the performance...
2020-11-14 13:57:56 +01:00
jeromenerf
dbac3e4e4a Fix documentation snippets
- zsh doesn't like "export var+=value", make it two steps
- meson was complaining with "ERROR: Must specify at least one directory name.", so add the relative "../.."
2020-11-06 21:30:39 +01:00
Daniel Eklöf
d263cb9723
install: say _why_ ncurses and scdoc is needed 2020-09-24 17:33:44 +02:00
Lennard Hofmann
df576d9a8e Fix typos 2020-08-15 23:29:38 +02:00
Daniel Eklöf
33e25e7f93
install: tllist is a *build* dependency, not a *runtime* dependency 2020-07-31 16:59:23 +02:00
Daniel Eklöf
e802fd4c9e
readme: move 'requirements' into INSTALL.md 2020-07-28 20:51:54 +02:00
Daniel Eklöf
f418115bdf
readme: move installation instructions to INSTALL.md 2020-07-28 20:49:23 +02:00