Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve theme documentation #5090

Closed
jrcii opened this issue Dec 9, 2022 · 2 comments
Closed

Improve theme documentation #5090

jrcii opened this issue Dec 9, 2022 · 2 comments
Labels
A-packaging Area: Packaging and bundling C-enhancement Category: Improvements

Comments

@jrcii
Copy link

jrcii commented Dec 9, 2022

I'm giving Helix a run and immediately ran into a gotcha with trying to set a theme. My experience may be related to the MacPorts build:

< install helix
> done
< helix
> Command not found
< port contents helix
> ... hx
"Oh the binary isn't helix (nor is there an alias/link for that command) it's hx, ok"
"Oh I see the port includes a bunch of themes, cool, how do I turn it on"
*Googles docs* "Do :theme <name>" 
< hx
< :theme onedark
> Theme not found
"Hm that's weird they were all in the list"
* Research *
< ln -s /opt/local/share/helix/runtime/themes ~/.config/helix/themes

Now themes work.

What would have saved me some time is if the docs explicitly explained that the install (at least in the case of MacPorts, I'm not sure what other package managers) may include some themes which are not available by default and must be copied to the theme directory first, or optionally the sym link strategy above to enable all of them.

@jrcii jrcii added the C-enhancement Category: Improvements label Dec 9, 2022
@kirawi kirawi added the A-documentation Area: Documentation improvements label Dec 9, 2022
pascalkuthe added a commit to pascalkuthe/macports-ports that referenced this issue Dec 9, 2022
We recently recived a bug report (helix-editor/helix#5090) from a user that was confused by the need to manually
symlink the runtime directory and asked us to improve our documentation in that regard.

We only document this requirement for manual builds because package manager usually provide a wrapper script that set s `HELIX_RUNTIME`.
I update the package to include such a script to avoid further problems. 


I also undid the removal of the `--frozen` flag. We track our `Cargo.lock` in git and keep it up to date so this should really not cause any problems.
I am not familiar with macports and don't have mac to test this with so feel free to edit this/use this a template.
@pascalkuthe
Copy link
Member

I don't think this is a documentation issue or a helix issue at all.
The runtime directory is critical for the function of helix, not just for helix and a core part of the installation.
Therefore package managers usually wrap helix in a wrapper script that sets HELIX_RUNTIME.
It appears that macports does not do this. I took a look at their package file and wanted to make a PR.
However their PR template requires a bunch of verification steps that require a mac (which I don't have).

Instead I submitted a ticket https://trac.macports.org/ticket/66428#ticket.
I think this should be fixed in mac ports, I don't think it makes sense for us to document the particularities of every package manager out there.

@pascalkuthe pascalkuthe added A-packaging Area: Packaging and bundling and removed A-documentation Area: Documentation improvements labels Dec 9, 2022
@pascalkuthe
Copy link
Member

I will close this issue since its not related to helix itself and there exists a macports ticket for this now. Sadly they have not been responding to me but I assume they will get to this eventually

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-packaging Area: Packaging and bundling C-enhancement Category: Improvements
Projects
None yet
Development

No branches or pull requests

3 participants