Skip to content

Add comprehensive README.md for macOS desktop app #189

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

Merged
merged 3 commits into from
Jun 25, 2025
Merged

Conversation

blink-so[bot]
Copy link
Contributor

@blink-so blink-so bot commented Jun 24, 2025

This PR adds a comprehensive README.md file for the Coder Desktop macOS application, based on the structure and content from the Windows version.

Changes

  • Added detailed project description and features
  • Documented Nix-based development environment setup
  • Explained build process using XcodeGen and make commands
  • Detailed project architecture and structure
  • Included contribution guidelines and licensing information

Testing

  • Verified README formatting and links
  • Confirmed all documented commands exist in the Makefile

The README provides clear guidance for new contributors and users wanting to understand the project structure and setup process.

Closes #173

- Document project setup and development environment using Nix
- Explain build process with XcodeGen and make commands
- Detail project architecture and structure
- Include contribution guidelines and licensing information
- Based on Windows desktop app README structure

Co-authored-by: matifali <10648092+matifali@users.noreply.github.com>
@ibetitsmike
Copy link

Is copying from Contributing.md necessary? Perhaps we can just link to it.

@ethanndickson ethanndickson merged commit a07ac2c into main Jun 25, 2025
@ethanndickson ethanndickson deleted the add-readme branch June 25, 2025 05:20
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

Successfully merging this pull request may close these issues.

Add a README.md
3 participants