summaryrefslogtreecommitdiffstats
path: root/README.md
AgeCommit message (Collapse)Author
2019-10-06Remove automatic config generationKirill Chibisov
Fixes #2818.
2019-08-01Organize Readme OS listAlex Touchet
2019-06-16Add Fedora Copr install instructionsPaul Schyska
2019-05-09Add Ubuntu PPA install instructionsMichael Murphy
2019-04-23Update wayland comment in READMEtrimental
2019-04-10Add Pop!_OS to the list of supported Linux distrosMichael Murphy
2019-04-10Switch 0.3.0 announcement link to httpsAlex Touchet
2019-04-09Document VC++ redistributable requirementChristian Duerr
This fixes #1972.
2019-04-09Set maximum Rust version to 1.31.0Christian Duerr
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-09Add 0.3.0 announcement blog to readmeChristian Duerr
2019-04-01Add official logov0.3.0-rc2Christian Duerr
2019-03-04Remove appveyor badge from readmeChristian Duerr
2019-02-25Add install instructions for Chocolatey to readmeStarz0r
2019-02-18Small Updates to the README (#2091)Nathan Lilienthal
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-02Document that alacritty requires winpty-agent on windows Zac Pullar-Strecker
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-01-17Make all configuration fields optionalChristian Duerr
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-12Add Solus install instructions to READMERobert Günzler
2018-12-28Fix Windows config location documontationChristian Duerr
The path `%APPDATA%` already includes the `Roaming` folder.
2018-12-27Make windows config location more sensibleZac Pullar-Strecker
2018-12-18Add Mageia install instructions to README.mdkekePower
2018-12-14Add scoop install instructions for windowsRoss Smith II
2018-11-17Add NixOS install instructions to README.mdRyan Morey
2018-11-15Document homebrew cask option for macOS installationFintan
2018-11-14Move .deb building instructions to INSTALL.mdHellsenberg
This fixes #1541.
2018-11-07Fix grammatical errors in READMEAlex Touchet
2018-11-04Update readme to link to the github releasesChristian Duerr
2018-11-01Add Instructions for installing on FreeBSDNiclas Zeising
Readd instructions for how to install pre-compiled alacritty packages on FreeBSD. This was accidentaly removed in cb6e065.
2018-10-27Add official Gentoo package to install instructionsGeorgy Yakovlev
2018-10-27Move gentoo install instructions, add windows to table of contentsZac Pullar-Strecker
2018-10-16Fix appveyor badge linkChristian Duerr
2018-10-16Add support for Windows (#1374)Zac Pullar-Strecker
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-14Extract manual installation instructionsChristian Duerr
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-09-28Add note about package install on FreeBSDNiclas Zeising
2018-09-24Add standalone terminfo definitionDaniel Eklöf
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-17Add `fontconfig-devel` dependency for building on Void LinuxVoidNoire
2018-09-17Give zsh completion file the correct name when installing with `cargo deb ↵Alexander Schlarb
--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-17Add mention of official arch linux packageChristian Rebischke
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-17Add latest blog post to READMEJoe Wilm
2018-07-29Remove "Why doesn't it support scrollback?" from FAQÁrni Dagur
Since scrollback is implemented on the scrollback branch, this section in the FAQ is redundant.
2018-07-28Merge master into scrollbackChristian Duerr
* 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 5ba34d4f9766a55a06ed5e3e44cc384af1b09f65 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-21Scrollback cleanupChristian Duerr
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-05-29Update to glutin 0.16.0Francesca Frangipane
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-01Fix completion install instructions for Fish on macOS (#1237)zhouji
2018-04-14alacritty: add support for OpenBSD.Matt T. Proud
This commit expands the conditional compilation directives to support building Alacritty for OpenBSD. The build succeeds, and Alacritty runs without issue once https://github.com/rust-lang/libc/pull/957 has been merged and added to a versioned libc release. This has been tested on the recently-released OpenBSD 6.3 on amd64 with rustc 1.24.0 from its standard ports tree.
2018-03-29Oxford commaBernardo Meurer
Added an Oxford comma to the OS support list
2018-03-29Fixed typos, alphabetical orderingBernardo Meurer
freeBSD->FreeBSD. Ordered OS support alphabetically.
2018-03-27add freeBSD on the topMatthiasSchuster
2018-03-23Fix typoSaugat Acharya
2018-03-12Add completion install instructions for FishJesse Cooke
2018-03-09Add centos missing dependencyashwinath