diff options
| author | Gokul Soumya | 2021-12-18 03:03:15 +0000 |
|---|---|---|
| committer | Gokul Soumya | 2021-12-18 03:03:15 +0000 |
| commit | d4fb1d06333315a3c6e9dc7f0ad8055d91551e3a (patch) | |
| tree | f43da59eec8b897359b84390b1c7d5b69f3bb169 /README.md | |
| parent | 016640f4fb6f620df13a2cab15e749d623197a51 (diff) | |
| parent | 3ef115d4203fab93f7efe4f65d8dd63cc4535b91 (diff) | |
Merge branch 'master' into cursor-shape-new
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 |