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

Include the help files (markdown) with the installer. #108

Closed
LordDurus opened this issue May 2, 2023 · 5 comments
Closed

Include the help files (markdown) with the installer. #108

LordDurus opened this issue May 2, 2023 · 5 comments
Assignees
Labels
enhancement New feature or request

Comments

@LordDurus
Copy link
Collaborator

Include the help files (markdown) with the installer.

This will make setup for new users easier.
The existing setting will be used, this way if someone wants to use a custom path for the help they can.

@LordDurus LordDurus added the enhancement New feature or request label May 2, 2023
@LordDurus LordDurus self-assigned this May 2, 2023
@LordDurus
Copy link
Collaborator Author

This is done in dev. Also fixed several issues with the hovertext not working in Linux (case sensitive file names).

@LordDurus
Copy link
Collaborator Author

Need a good way of updating the help files. Currently I'll have to remember to do it.

LordDurus added a commit that referenced this issue May 2, 2023
LordDurus added a commit that referenced this issue May 2, 2023
@DualBrain
Copy link
Contributor

Are there help files for the actual extension? How do you get to these? Or are you talking about the QB64 markdown files? If so, I thought the solution that was there was already working? If not working, what needs to be done?

@LordDurus
Copy link
Collaborator Author

These are the qb64 help files. Used for the F1 help and hovertext. Including them with the extension gives new users one less thing to setup.

The extension still uses the helpPath setting. It will get defaulted to the markdown files included with the extension. But it can be changed to the QB64 folder. If the helpPath is already set it won't get changed. The setting will be already set for anyone who already has working hovertext/f1.

For now I just copied the files in since they don't change very much.

Having a process that pulls them down at build would be better.

I did find an issue while I was in there. If the case of the keywork in the code didn't match the case of the filename. Then the hovertext would show on Linux. I fixed that.

I'm going to create a different issue for this, what files are needed to QB64 IDE running? I'd like to include that as well. Then someone would only need to install the extension to start coding.

@LordDurus
Copy link
Collaborator Author

Looks like including QB64 IDE is not going to work. It needs about 550mb of support files. The c/c++ compiler mostly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants