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

Add macOS installation document #1538

Open
2 tasks done
thomastthai opened this issue Feb 16, 2025 · 3 comments
Open
2 tasks done

Add macOS installation document #1538

thomastthai opened this issue Feb 16, 2025 · 3 comments
Assignees
Labels
bug Something isn't working macos Issue pertains to macos; jtroo has no macOS devices and does not maintain the support for this OS.

Comments

@thomastthai
Copy link
Contributor

thomastthai commented Feb 16, 2025

Requirements

Describe the bug

I'd happily turn #1537 into a document for inclusion in docs/setup-macos.md and a reference in REAME.md. There are other configuration sections for macOS I'd like to add soon, e.g., #975 configuring function key OS actions or features such as brightness, Mission Control, Spotlight, and more, as indicated by icons on the keys.

Relevant kanata config

No response

To Reproduce

Missing macOS setup documentation.

Expected behavior

Have detailed macOS setup documentation.

Kanata version

1.8.0

Debug logs

No response

Operating system

macOS

Additional context

No response

@thomastthai thomastthai added the bug Something isn't working label Feb 16, 2025
@thomastthai thomastthai changed the title Bug: add macOS installation document Add macOS installation document Feb 16, 2025
@jtroo
Copy link
Owner

jtroo commented Feb 17, 2025

Sounds good to me!

@jtroo jtroo added the macos Issue pertains to macos; jtroo has no macOS devices and does not maintain the support for this OS. label Feb 18, 2025
@thomastthai
Copy link
Contributor Author

@jtroo, the document has a lot of images. What's your preference in organizing the images along with the markdown file?

@jtroo
Copy link
Owner

jtroo commented Feb 18, 2025

Please put the images alongside the markdown file into a subdirectory of docs/, e.g. docs/macos-install/.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working macos Issue pertains to macos; jtroo has no macOS devices and does not maintain the support for this OS.
Projects
None yet
Development

No branches or pull requests

2 participants