diff options
| author | Blaž Hrastnik | 2022-02-13 09:31:51 +0000 |
|---|---|---|
| committer | Blaž Hrastnik | 2022-02-13 09:31:51 +0000 |
| commit | bd549d8a20cce98e24c8653a4a86107c786cbaa3 (patch) | |
| tree | 0780b58d41b6181e69023265cdb54517e2953778 /README.md | |
| parent | 7ad8eaaef0b292f4be6c66298cea40d2b928e172 (diff) | |
| parent | 7083b98a388b30e0b61caac9bf6ccc1d79eadf81 (diff) | |
Merge remote-tracking branch 'origin/master' into debug
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 3 insertions, 17 deletions
@@ -44,8 +44,8 @@ cargo install --path helix-term This will install the `hx` binary to `$HOME/.cargo/bin`. Helix also needs its runtime files so make sure to copy/symlink the `runtime/` directory into the -config directory (for example `~/.config/helix/runtime` on Linux/macOS). This location can be overriden -via the `HELIX_RUNTIME` environment variable. +config directory (for example `~/.config/helix/runtime` on Linux/macOS, or `%AppData%/helix/runtime` on Windows). +This location can be overriden via the `HELIX_RUNTIME` environment variable. Packages already solve this for you by wrapping the `hx` binary with a wrapper that sets the variable to the install dir. @@ -65,21 +65,7 @@ brew install helix # Contributing -Contributors are very welcome! **No contribution is too small and all contributions are valued.** - -Some suggestions to get started: - -- You can look at the [good first issue](https://github.com/helix-editor/helix/issues?q=is%3Aopen+label%3AE-easy+label%3AE-good-first-issue) label on the issue tracker. -- Help with packaging on various distributions needed! -- To use print debugging to the [Helix log file](https://github.com/helix-editor/helix/wiki/FAQ#access-the-log-file), you must: - * Print using `log::info!`, `warn!`, or `error!`. (`log::info!("helix!")`) - * Pass the appropriate verbosity level option for the desired log level. (`hx -v <file>` for info, more `v`s for higher severity inclusive) -- If your preferred language is missing, integrating a tree-sitter grammar for - it and defining syntax highlight queries for it is straight forward and - doesn't require much knowledge of the internals. - -We provide an [architecture.md](./docs/architecture.md) that should give you -a good overview of the internals. +Contributing guidelines can be found [here](./docs/CONTRIBUTING.md). # Getting help |