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

document package features in the README #216

Open
tpapp opened this issue Dec 9, 2024 · 0 comments
Open

document package features in the README #216

tpapp opened this issue Dec 9, 2024 · 0 comments

Comments

@tpapp
Copy link
Collaborator

tpapp commented Dec 9, 2024

Our README is currently a bit sparse and technical. We should expand on it by explaining some package features.

Specifically:

highlights from the API

Everything we define with defcustom should be mentioned. Various customizations, such as (define-key julia-mode-map (kbd "TAB") 'julia-latexsub-or-indent) to get the old tab completion, should be mentioned.

related packages

julia-repl, eglot-jl, julia-ts-mode, other suggestions welcome

maybe

Maybe a screenshot? Eg as embedded HTML.

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

No branches or pull requests

1 participant