Commit graph

65 commits

Author SHA1 Message Date
Jake Langford
ad2061bab6
Update my name README.md (#7656) 2023-07-17 14:09:19 +09:00
David Else
707457c632
Rewrite and refactor all documentation (#5534)
* 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>
2023-03-06 18:27:17 +09:00
Jaeho Choi
0eba0db4a0
docs: Fix PowerShell runtime linking command (#5822) 2023-02-05 13:31:20 -06:00
Mike Trinkala
95d4fdc255
Update the cargo installation instructions to include --locked (#5443) 2023-01-07 16:42:45 -05:00
blt__
d4565b4404
Mention the icon in README.md (#5370) 2023-01-02 11:48:09 -06:00
Pascal Kuthe
b677c6a019
Add logo with text included (#4973) 2022-12-03 11:05:15 +09:00
Matouš Dzivjak
c38519c57a
feat(docs): style readme & add badges (#4970)
Centre Helix title and logo and add badge with latest
release and link to matrix chat.
2022-12-02 20:56:36 +09:00
Blaž Hrastnik
e92651816d
Forgot to set the height 2022-12-02 12:07:08 +09:00
Blaž Hrastnik
dc1ec56322
Add the new logo! 2022-12-02 12:06:17 +09:00
Zhizhen He
0c30aeea5b
fix typo (#4656) 2022-11-08 11:02:49 -06:00
0xflotus
75d7e0555e
fix: small error (#4651) 2022-11-08 08:29:48 -06:00
Greg Troszak
fbf8078611
Clarify use of HELIX_RUNTIME (#4382) 2022-10-20 19:39:30 -05:00
Alex
8c9bb23650
Update windows install instructions (#4351) 2022-10-19 17:19:03 -05:00
Jacob Kiesel
c54a0363bb
Rearrange README.md slightly (#4206) 2022-10-11 18:54:18 -05:00
David
7af7dadd17
Add instructions for gnome desktop support using the .desktop file (#4165) 2022-10-10 12:23:36 -05:00
taupiqueur
a73e83ef4d
Fix typos (#3858) 2022-09-17 06:34:48 -05:00
NotAgentBilly
df1ed0a5fd
xcopy - assume destination is a directory (#3686) 2022-09-05 08:42:17 -05:00
Michael Davis
e441b1c472
packaging: Point to homebrew-core instead of tap (#3513) 2022-08-31 17:45:38 +09:00
jdrst
598aa7c424
adds xcopy param to recursively copy runtime folder (#3378) 2022-08-09 20:47:04 -05:00
Kyle L. Davis
cca83af3fd
Update README command table (#3224) 2022-07-28 05:37:10 -05:00
川田 恵氏 (Kawada Keishi a.k.a megumish)
244825b9e1
Add runtime xcopy command on powershell in docs (#2958) 2022-07-04 12:32:46 -05:00
Marcin Puc
cd4622db9b
Update from-source install instruction in README (#2603) 2022-05-29 10:52:26 -05:00
unrelentingtech
030e7ab988
fix(docs): cleanup obsolete indents.toml mentions (#2327) 2022-04-29 12:40:59 -05:00
matan h
02426072cb
add table of OS/command for copy/symlink the runtime folder to the config (#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>
2022-04-20 10:44:11 +09:00
Michael Davis
78b1600943
Improve documentation on Language Server installation (#2037) 2022-04-09 12:17:32 +05:30
Michael Davis
7044d7d804 rename '--fetch/build-grammars' flags into '--grammar fetch/build'
The old flags were a bit long. --grammar is also aliased to -g to make
it even easier.
2022-03-10 17:31:57 +09:00
Michael Davis
8081e9f052 replace all submodule documentation with flags documentation 2022-03-10 17:31:57 +09:00
Arjun P
e1a92fd399
Readme: fix typo (#1695) 2022-02-22 21:31:19 +09:00
WindSoilder
0c447151cf
In README, add example for windows config directory (#1273)
* better doc for windows user

* fix doc
2021-12-16 10:48:49 +09:00
Gokul Soumya
71292f9f11 docs: Auto generate command list 2021-12-08 10:23:50 +09:00
NNB
1724930765
Fix "good first issue" link (#1140) 2021-11-22 07:16:26 +09:00
Carter Snook
e505bf2b48
chore(doc): use faq for finding helix log file (#963) 2021-11-03 09:57:18 +09:00
Za Wilcox
68697cb332
Move 'Note' from incorrect location (#921) 2021-10-29 14:11:42 +09:00
Omnikar
6063ecf3b4
Add note about FAQ to README.md (#848) 2021-10-16 10:05:29 +09:00
Sven-Hendrik Haase
4f8dc4cad8
Fix it's -> its (#676) 2021-08-30 17:58:22 +09:00
Kirawi
b0acd8c3a6
Update README.md (#581)
* Update README.md

* Update README.md
2021-08-14 13:28:27 +09:00
Omnikar
bfcc6e2ca5 Update README.md 2021-08-02 17:55:32 +09:00
Blaž Hrastnik
0fdb626c2c Remove embed_runtime feature
It's no longer practical to maintain. Closes #451
2021-07-30 16:27:22 +09:00
Blaž Hrastnik
000b7b7c97 Make instructions regarding runtime clearer 2021-07-18 00:22:58 +09:00
Blaž Hrastnik
866b32b5d7 Add repology.org packaging status 2021-06-23 01:05:22 +09:00
Blaž Hrastnik
39d59216e4
Fix link to good first issue 2021-06-23 00:51:30 +09:00
Wojciech Kępka
45793d7c09 Update README 2021-06-12 17:26:41 +08:00
Kelly Thomas Kline
8f1eb7b2b0 Add trace log primer to the Contributing section 2021-06-08 12:21:25 +09:00
Blaž Hrastnik
f48a60b8e2 Release 0.0.10 2021-06-07 09:42:15 +09:00
Ethan Bodzioney
843c2cdebd
Install instructions and version number corrections (#148)
* Add MacOS install instructions

* Change version name argument

When using the -V command to get the version you are given 'helix-term x.x.x', I changed this to just helix as it makes more sense.

* Fixed version number

* Fixed version number

* Fixed version number

* Fixed version number

* Fixed version number

* Fixed version number
2021-06-07 09:14:06 +09:00
Brian Dawn
ae105812d6 Apply suggestions from code review
Co-authored-by: Ivan Tham <pickfire@riseup.net>
2021-06-06 10:49:17 +09:00
Brian Dawn
62d181de78 Provide a feature flag to be able to embed the runtime folder.
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.
2021-06-06 10:49:17 +09:00
Blaž Hrastnik
407b37c327 Better link to Matrix 2021-06-05 13:04:13 +09:00
Eric Leijonmarck
5f49bafbe8
Update README.md 2021-06-02 17:05:15 +02:00
Eric Leijonmarck
c960bcfc24
Update README.md 2021-06-02 13:15:31 +02:00