aboutsummaryrefslogtreecommitdiff
path: root/book/src/install.md
Commit message (Collapse)AuthorAge
* misc doc fixes/improvements (#7282)Tshepang Mbambo2023-06-08
|
* Update install.md instructions regarding symlinks (#7231)Rich Seymour2023-06-05
| | | | | | | * Update install.md Fixes `ln` command line bug that could hit users moving from packaged to source builds. * Remove extra 'how to' command example
* book: Mention Helix package in nixpkgs (#7064)Martin Weinelt2023-05-26
|
* Add Flathub as third party repository (#6994)David Else2023-05-09
|
* Improve and update the installation documentation (#6809)David Else2023-04-19
|
* Add Windows install instructions using Winget (#6602)Nico Bos2023-04-09
|
* Add instructions for installing via AppImage (#6368)Gautam Panchal2023-03-20
|
* Generalised to multiple runtime directories with priorities (#5411)paul-scott2023-03-09
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Generalised to multiple runtime directories with priorities This is an implementation for #3346. Previously, one of the following runtime directories were used: 1. `$HELIX_RUNTIME` 2. sibling directory to `$CARGO_MANIFEST_DIR` 3. subdirectory of user config directory 4. subdirectory of path to helix executable The first directory provided / found to exist in this order was used as a root for all runtime file searches (grammars, themes, queries). This change lowers the priority of `$HELIX_RUNTIME` so that the user config runtime has higher priority. More significantly, all of these directories are now searched for runtime files, enabling a user to override default or system-level runtime files. If the same file name appears in multiple runtime directories, the following priority is now used: 1. sibling directory to `$CARGO_MANIFEST_DIR` 2. subdirectory of user config directory 3. `$HELIX_RUNTIME` 4. subdirectory of path to helix executable One exception to this rule is that a user can have a `themes` directory directly in the user config directory that has higher piority to `themes` directories in runtime directories. That behaviour has been preserved. As part of implementing this feature `theme::Loader` was simplified and the cycle detection logic of the theme inheritance was improved to cover more cases and to be more explicit. * Removed AsRef usage to avoid binary growth * Health displaying ;-separated runtime dirs * Changed HELIX_RUNTIME build from src instructions * Updated doc for more detail on runtime directories * Improved health symlink printing and theme cycle errors The health display of runtime symlinks now prints both ends of the link. Separate errors are given when theme file is not found and when the only theme file found would form an inheritence cycle. * Satisfied clippy on passing Path * Clarified highest priority runtime directory purpose * Further clarified multiple runtime details in book Also gave markdown headings to subsections. Fixed a error with table indentation not building table that also appears present on master. --------- Co-authored-by: Paul Scott <paul.scott@anu.edu.au> Co-authored-by: Blaž Hrastnik <blaz@mxxn.io>
* Rewrite and refactor all documentation (#5534)David Else2023-03-06
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Rewrite and refactor all documentation * Rewrite and refactor the guides * update runtime directory instructions for windows * Update the Ubuntu 3rd party repo section with 22.10 * Merge from upstream * Rewrite and refactor all documentation * Apply suggestions from code review Apply the suggestions that can be committed from the GitHub web interface. Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Add Windows themes folder Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com> * Apply the rest of the suggestions from the code review * Revert "Apply the rest of the suggestions from the code review" This reverts commit 498be1b7a1aec3ff567b95130148628beeef9b77. * Revert "Merge branch 'rewrite-and-refactor-all-documentation' of github.com:David-Else/helix into rewrite-and-refactor-all-documentation" This reverts commit 7c8404248ffef73b80b9051d5a4359c5bcfa5d1a, reversing changes made to d932969cfc9fadda12a74cc01665919dee7152fb. * Apply code review suggestions * Changes after re-reading all documents * Missed a full stop * Code review suggestions and remove macOS and Windows specific sections * Add OpenBSD to heading * Add back macOS and Windows sections and further simplify and improve * Change wording to nightly * Remove README installation section and turn into a link * Simplify building from source and follow code review suggestions * Code review revisions * Fix copy paste mistake * Apply the latest code review suggestions * More small code review items * Change minor modes for code review * Fix link and typos * Add note that you need a c++ compiler to install the tree-sitter grammars * Add pacman example * Make sure all headings are lower case * Revert to the original passage adding a reference to Windows that was missing * Update book/src/guides/adding_languages.md Fix grammar typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Update book/src/install.md Fix tree sitter typo Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * Remove TOC links to main heading --------- Co-authored-by: CptPotato <3957610+CptPotato@users.noreply.github.com> Co-authored-by: Michael Davis <mcarsondavis@gmail.com> Co-authored-by: digidoor <37601466+digidoor@users.noreply.github.com>
* docs: Fix PowerShell runtime linking command (#5822)Jaeho Choi2023-02-05
|
* book: Link MSYS2 proper command page (#5601)yashpalgoyal13042023-01-20
|
* doc: add build instructions for musl-libc (#5572)Pascal Kuthe2023-01-18
|
* book: Recommend '--locked' for cargo installs (#5438)Michal Melewski2023-01-08
|
* book: Clarify install commands for msys2 in Windows (#5363)Biswapriyo Nath2023-01-07
|
* fix typo (#4656)Zhizhen He2022-11-08
|
* fix: small error (#4651)0xflotus2022-11-08
|
* Update windows install instructions (#4530)Konstantin Podsvirov2022-10-30
|
* Clarify use of `HELIX_RUNTIME` (#4382)Greg Troszak2022-10-21
|
* Update windows install instructions (#4351)Alex2022-10-19
|
* Add instructions for gnome desktop support using the `.desktop` file (#4165)David2022-10-10
|
* xcopy - assume destination is a directory (#3686)NotAgentBilly2022-09-05
|
* packaging: Point to homebrew-core instead of tap (#3513)Michael Davis2022-08-31
|
* adds xcopy param to recursively copy runtime folder (#3378)jdrst2022-08-10
|
* nix flake: make the binary cache "just work" (#2999)Timothy DeHerrera2022-07-09
|
* book: add wiki links to the title page and install page (#3017)Amit Beka2022-07-09
| | | Co-authored-by: amitbeka <--->
* Add runtime `xcopy` command on powershell in docs (#2958)川田 恵氏 (Kawada Keishi a.k.a megumish)2022-07-04
|
* mention the requirement of C++ compiler for building grammar in doc (#2592)nitish-172022-05-28
|
* Add documentation for `hx --health` (#2357)Robert Walter2022-05-02
|
* fix typos (#2304)chunghha2022-04-27
|
* add table of OS/command for copy/symlink the runtime folder to the config ↵matan h2022-04-20
| | | | | | | | | | | | | | | | | | | | | | | (#2073) * create table of OS and commands in the readme * add link to wiki from health check (without color; just simple println) * move the table from readme to docs and add link from the readme to docs * drop copy on unix,and apply some style fixes from the conversations * by mistake, I edit master insted of develop * remove this file from pr * Update README.md Co-authored-by: Michael Davis <mcarsondavis@gmail.com> * copy table to readme Co-authored-by: Michael Davis <mcarsondavis@gmail.com>
* Add install instructions for Void Linux (#1911)Marcin Puc2022-03-31
|
* rename '--fetch/build-grammars' flags into '--grammar fetch/build'Michael Davis2022-03-10
| | | | | The old flags were a bit long. --grammar is also aliased to -g to make it even easier.
* replace all submodule documentation with flags documentationMichael Davis2022-03-10
|
* add workflow for pushing nix flake artifacts to Cachix (#1721)Michael Davis2022-03-02
| | | | | | | | | * add workflow for pushing nix flake artifacts to Cachix * add docs on using the cachix cache from nix * remove submodule clone from cachix workflow * remove flake check
* Add instructions for Fedora Linux (#1270)Chetan Vardhan2021-12-17
| | | | | | | * Add instructions for Fedora Linux * Update README.md * Update install.md
* Remove defunct helix-bin AUR linkNicholas Boyd Isacsson2021-11-29
|
* Improve docs, fix up a few highlight scopesBlaž Hrastnik2021-09-07
|
* Remove embed_runtime featureBlaž Hrastnik2021-07-30
| | | | It's no longer practical to maintain. Closes #451
* Add repology.org packaging statusBlaž Hrastnik2021-06-22
|
* Add homebrew tap instructions againBlaž Hrastnik2021-06-17
|
* Apply suggestions from code reviewBrian Dawn2021-06-06
| | | | Co-authored-by: Ivan Tham <pickfire@riseup.net>
* Provide a feature flag to be able to embed the runtime folder.Brian Dawn2021-06-06
| | | | | | These changes provide a new feature flag "embed_runtime" that when enabled and built in release mode will embed the runtime folder into the resulting binary.
* Update install notesBlaž Hrastnik2021-06-02
|
* Update mdbook styling, add link to AURBlaž Hrastnik2021-05-30
|
* Update the book (keymaps).Blaž Hrastnik2021-05-12
|
* Add book/ (mdbook based user guide)Blaž Hrastnik2021-04-05