Commit Graph

123 Commits

Author SHA1 Message Date
Valentin Ignatev 31e01cc0e0
Add GNU Guix installation instructions 2020-03-01 04:33:36 +03:00
bgkillas 933b2e25ff
Add Alpine Linux installation instructions 2020-02-18 00:15:05 +00:00
Kirill Chibisov 5cd13f8c47
Document that Alacritty does not create config 2020-02-07 23:39:39 +00:00
Christian Duerr c2c8d6bf37
Move Alacritty to organization
This fixes various outdated links pointing to the old jwilm/alacritty
repository.

Since `copypasta` now has its own github repository at
https://github.com/alacritty/copypasta, the sources have been removed
from Alacritty.
2020-01-11 02:23:13 +01:00
Kirill Chibisov d4dc1f7b14 Remove outdated information from README 2019-12-29 22:48:27 +00:00
David Hewitt 7a957978e4 Default to ConPTY instead of WinPTY 2019-12-21 21:23:18 +00:00
jansol 1836d4679a Add prerendered PNG and simplified SVG logo
This should help with compatibility problems with some platforms like
KDE, that do not support all the features necessary for rendering the
default Alacritty logo.
2019-11-28 19:09:14 +01:00
Kirill Chibisov 24651a6144 Remove automatic config generation
Fixes #2818.
2019-10-06 12:47:20 +02:00
Alex Touchet 28b726cbfa Organize Readme OS list 2019-08-01 04:58:32 +00:00
Paul Schyska 3950b5cb2f Add Fedora Copr install instructions 2019-06-16 19:47:59 +00:00
Michael Murphy 7738c52ed4 Add Ubuntu PPA install instructions 2019-05-09 17:56:34 +00:00
trimental cf1a35bcb4 Update wayland comment in README 2019-04-23 15:27:34 +00:00
Michael Murphy d406627acb Add Pop!_OS to the list of supported Linux distros 2019-04-10 18:29:53 +00:00
Alex Touchet 94ab5f2b5b Switch 0.3.0 announcement link to https 2019-04-10 18:11:20 +00:00
Christian Duerr 272a583bd0
Document VC++ redistributable requirement
This fixes #1972.
2019-04-09 21:05:26 +00:00
Christian Duerr 56fea343ff
Set maximum Rust version to 1.31.0
By setting the minimum Rust version and enforcing it with CI, Alacritty
should hopefully make it possible for maintainers to package the
application even on distributions which are not rolling release.

The 1.31.0 target has been chosen here because it's the first version of
the Rust 2018 release. Bumping this version in the future should be
considered to be a breaking change and should only be done with caution
and in consideration of the supported Rust versions of the major
distributions available.

This fixes #2277.
2019-04-09 19:29:46 +00:00
Christian Duerr f2a5def2cb
Add 0.3.0 announcement blog to readme 2019-04-09 16:54:09 +00:00
Christian Duerr 6f4d1afcf8
Add official logo 2019-04-01 22:41:20 +00:00
Christian Duerr ba9aaa0539
Remove appveyor badge from readme 2019-03-04 16:23:19 +00:00
Starz0r 8d5e1226d5 Add install instructions for Chocolatey to readme 2019-02-25 23:45:17 +00:00
Nathan Lilienthal 66b3f4c877
Small Updates to the README (#2091)
Update the README and related files.

This commit generally updates some language in the "About" section, and other sections with respect to keeping accurate information, and laying out the project goals in a clear way.

We're also marking Alacritty as "beta" software at this point, not that this has any explicit meaning.
2019-02-18 14:54:46 -05:00
Zac Pullar-Strecker 863d5581a6 Document that alacritty requires winpty-agent on windows
To make things easier to understand for Windows users, the 
relationship between Alacritty and the WinPTY agent has been
clarified in the documentation.

This also bundles the windows agent and exe together in a zip file to
make distribution for windows easier on the user.
2019-02-02 12:00:29 +00:00
Christian Duerr 0d16478f5d
Make all configuration fields optional
All configuration fields now have fallback values which will be used if
the field is not present. This includes mouse, key bindings and platform
specific differences.

The mouse and key bindings are now filled by default, if the user
rebinds a default mapping, it will be overwritten. To unbind a default
binding, it can be mapped to `chars: ""`.

Since all platform differences can now be correctly handled by the
`src/config/mod.rs` code, it's no longer necessary to maintain separate
configuration files, so the `alacritty_macos.yml` and
`alacritty_windows.yml` have been deleted.

Fixes #40.
Fixes #1923.
2019-01-17 09:17:26 +00:00
Robert Günzler 4caf3d32cd Add Solus install instructions to README 2019-01-12 19:55:03 +00:00
Christian Duerr ec6f756946
Fix Windows config location documontation
The path `%APPDATA%` already includes the `Roaming` folder.
2018-12-28 15:26:58 +00:00
Zac Pullar-Strecker 6d7647c890 Make windows config location more sensible 2018-12-27 14:16:31 +00:00
kekePower e1ee890750 Add Mageia install instructions to README.md 2018-12-18 21:41:17 +00:00
Ross Smith II e4db833137 Add scoop install instructions for windows 2018-12-14 10:00:50 +00:00
Ryan Morey 3593ec72dd Add NixOS install instructions to README.md 2018-11-17 18:29:08 +00:00
Fintan ba76ac8661 Document homebrew cask option for macOS installation 2018-11-15 13:58:24 +00:00
Hellsenberg 5baf1fceab Move .deb building instructions to INSTALL.md
This fixes #1541.
2018-11-14 21:49:34 +00:00
Alex Touchet 81617983bb Fix grammatical errors in README 2018-11-07 20:04:41 +00:00
Christian Duerr 0e49bfb02a
Update readme to link to the github releases 2018-11-04 00:13:18 +00:00
Niclas Zeising a846faa6ef Add Instructions for installing on FreeBSD
Readd instructions for how to install pre-compiled alacritty packages on
FreeBSD.  This was accidentaly removed in cb6e065.
2018-11-01 20:09:19 +00:00
Georgy Yakovlev e5ca26518e Add official Gentoo package to install instructions 2018-10-27 11:14:13 +00:00
Zac Pullar-Strecker 8f2a4b89df Move gentoo install instructions, add windows to table of contents 2018-10-27 15:58:51 +13:00
Christian Duerr 9bc888fbe5
Fix appveyor badge link 2018-10-16 19:16:12 +00:00
Zac Pullar-Strecker 15e0deae2b Add support for Windows (#1374)
Initial support for Windows is implemented using the winpty translation
layer. Clipboard support for Windows is provided through the `clipboard`
crate, and font rasterization is provided by RustType.

The tty.rs file has been split into OS-specific files to separate
standard pty handling from the winpty implementation.

Several binary components are fetched via build script on windows
including libclang and winpty. These could be integrated more directly
in the future either by building those dependencies as part of the
Alacritty build process or by leveraging git lfs to store the artifacts.

Fixes #28.
2018-10-16 10:02:52 -07:00
Christian Duerr cb6e0653fa
Extract manual installation instructions
Alacritty's manual installation instructions take up a lot of space in
the README and they are hard to navigate because there's a lot of
information for specific distros which are irrelevant to most users.

To improve this situation, the manual installation section has been
moved to the `INSTALL.md` file. This allows keeping the readme to a
minimum which just includes the straight-forward instructions required
to install it on systems which provide packages for it.

Having a separate file also makes it possible to add a full index just
for the installation instructions, which makes it possible to skip
sections which are irrelevant.
2018-10-14 21:01:09 +00:00
Niclas Zeising 88076938ed Add note about package install on FreeBSD 2018-09-28 20:11:44 +00:00
Daniel Eklöf ec3a80427b Add standalone terminfo definition
This replaces the current definitions, which depend on the system's
'xterm-256color' terminfo definition with the `alacritty` and
`alacritty-direct` definitions.

The new definitions are completely standalone.

The default `TERM` value has been changed to be dynamically
set based on the definitions installed on the system. Alacritty will
try to use the `alacritty` definition first and fall back to
`xterm-256color` if the `alacritty` definition is not present.
2018-09-24 19:06:12 +00:00
VoidNoire 55e675a3d8 Add `fontconfig-devel` dependency for building on Void Linux 2018-09-17 22:01:54 +00:00
Alexander Schlarb e2c1e56b25 Give zsh completion file the correct name when installing with `cargo deb --install`
The zsh completion name for the deb installer has been corrected.

The installation instructions for the zsh completions have also been
updated to make it possible to install them without root permissios.
2018-09-17 21:37:00 +00:00
Christian Rebischke 1f243468dc Add mention of official arch linux package
Since Alacritty does not require the AUR anymore, its mention has been
removed from the README.

To make future changes simpler, the README has also been reworded so
less changes are required for adding new operating systems.
2018-09-17 19:09:39 +00:00
Joe Wilm 8b71eede52 Add latest blog post to README 2018-09-17 08:56:15 -07:00
Árni Dagur 23601fbefc Remove "Why doesn't it support scrollback?" from FAQ
Since scrollback is implemented on the scrollback branch,
this section in the FAQ is redundant.
2018-07-29 13:41:32 +00:00
Christian Duerr c4a0f9c4cb
Merge master into scrollback
* Allow disabling DPI scaling

This makes it possible to disable DPI scaling completely, instead the
the display pixel ration will always be fixed to 1.0.

By default nothing has changed and DPI is still enabled, this just seems
like a better way than running `WINIT_HIDPI_FACTOR=1.0 alacritty` every
time the user wants to start alacritty.

It would be possible to allow specifying any DPR, however I've decided
against this since I'd assume it's a very rare usecase. It's also still
possible to make use of `WINIT_HIDPI_FACTOR` to do this on X11.

Currently this is not updated at runtime using the live config update,
there is not really much of a technical limitation why this woudn't be
possible, however a solution for that issue should be first added in
jwilm/alacritty#1346, once a system is established for changing DPI at
runtime, porting that functionality to this PR should be simple.

* Add working --class and --title CLI parameters

* Reduce Increase-/DecreaseFontSize step to 0.5

Until now the Increase-/DecreaseFontSize keybinds hand a step size of 1.0. Since the font size however is multiplied by two to allow more granular font size control, this lead to the bindings skipping one font size (incrementing/decrementing by +-2).

To fix this the step size of the Increase-/DecreaseFontSize bindings has been reduced to the minimum step size that exists with the current font configuration (0.5). This should allow users to increment and decrement the font size by a single point instead of two.

This also adds a few tests to make sure the methods for increasing/decreasing/resetting font size work properly.

* Add Copy/Cut/Paste keys

This just adds support for the Copy/Cut/Paste keys and sets up
Copy/Paste as alternative defaults for Ctrl+Shift+C/V.

* Move to cargo clippy

Using clippy as a library has been deprecated, instead the `cargo
clippy` command should be used instead. To comply with this change
clippy has been removed from the `Cargo.toml` and is now installed with
cargo when building in CI.

This has also lead to a few new clippy issues to show up, this includes
everything in the `font` subdirectory. This has been fixed and `font`
should now be covered by clippy CI too.

This also upgrades all dependencies, as a result this fixes #1341 and
this fixes #1344.

* Override dynamic_title when --title is specified

* Change green implementation to use the macro

* Ignore mouse input if window is unfocused

* Make compilation of binary a phony target

* Add opensuse zypper install method to readme

* Fix clippy issues

* Update manpage to document all CLI options

The introduction of `--class` has added a flag to the CLI without adding
it to the manpage. This has been fixed by updating the manpage.

This also adds the default values of `--class` and `--title` to the CLI
options.

* Remove unnecessary clippy lint annotations

We moved to "cargo clippy" in 5ba34d4f97 and
removing the clippy lint annotations in `src/lib.rs` does not cause any additional warnings.

This also changes `cargo clippy` to use the flags required for checking integration tests.

* Enable clippy in font/copypasta crates

Enabled clippy in the sub-crates font and copypasta. All issues
that were discovered by this change have also been fixed.

* Remove outdated comment about NixOS

* Replace debug asserts with static_assertions

To check that transmutes will work correctly without having to rely on
error-prone runtime checking, the `static_assertions` crate has been
introduced. This allows comparing the size of types at compile time,
preventing potentially silent breakage.

This fixes #1417.

* Add `cargo deb` build instructions

Updated the `Cargo.toml` file and added a `package.metadata.deb`
subsection to define how to build a debian "deb" install file using
`cargo deb`. This will allow debian/ubuntu users to install `alacritty`
using their system's package manager. It also will make it easier to
provide pre-built binaries for those systems.

Also fixed a stray debug line in the bash autocomplete script that was
writting to a tempfile.

* Add config for unfocused window cursor change

* Add support for cursor shape escape sequence

* Add bright foreground color option

It was requested in jwilm/alacritty#825 that it should be possible to
add an optional bright foreground color.

This is now added to the primary colors structure and allows the user to
set a foreground color for bold normal text. This has no effect unless
the draw_bold_text_with_bright_colors option is also enabled.

If the color is not specified, the bright foreground color will fall
back to the normal foreground color.

This fixes #825.

* Fix clone URL in deb install instructions

* Fix 'cargo-deb' desktop file name

* Remove redundant dependency from deb build

* Switch from deprecated `std::env::home_dir` to `dirs::home_dir`

* Allow specifying modifiers for mouse bindings

* Send newline with NumpadEnter

* Add support for LCD-V pixel mode

* Add binding action for hiding the window

* Switch to rustup clippy component

* Add optional dim foreground color

Add optional color for the dim foreground (`\e[2m;`)
Defaults to 2/3 of the foreground color. (same as other colors).

If a bright color is dimmed, it's displayed as the normal color. The
exception for this is when the bright foreground is dimmed when no
bright foreground color is set. In that case it's treated as a normal
foreground color and dimmed to DimForeground.

To minimize the surprise for the user, the bright and dim colors have
been completely removed from the default configuration file.
Some documentation has also been added to make it clear to users what
these options can be used for.

This fixes #1448.

* Fix clippy lints and run font tests on travis

This fixes some existing clippy issues and runs the `font` tests through travis.

Testing of copypasta crate was omitted due to problens when running on headless travis-ci environment (x11 clipboard would fail).

* Ignore errors when logger can't write to output

The (e)print macro will panic when there is no output available to
write to, however in our scenario where we only log user errors to
stderr, the better choice would be to ignore when writing to stdout or
stderr is not possible.

This changes the (e)print macro to make use of `write` and ignore
any potential errors.

Since (e)println rely on (e)print, this also solves potential failuers
when calling (e)println.

With this change implemented, all of logging, (e)println and (e)print
should never fail even if the stdout/stderr is not available.
2018-07-28 23:10:13 +00:00
Christian Duerr f50ca1a54c
Scrollback cleanup
There were some unneeded codeblocks and TODO/XXX comments in the code
that have been removed. All issues marked with TODO/XXX have either been
already resolved or tracking issues exist.
2018-07-21 17:17:41 +00:00
Francesca Frangipane 765949f256 Update to glutin 0.16.0
Note that `WM_CLASS` is now set to `"alacritty", "Alacritty"`
instead of the previous value of `"Alacritty", "Alacritty"`. This
seems to be more standard.

This also contains some revised recommendations for installing the
`.desktop` file.
2018-05-29 09:50:49 -07:00
zhouji e2abd8945a Fix completion install instructions for Fish on macOS (#1237) 2018-05-01 10:58:52 -07:00