incubator-xtable icon indicating copy to clipboard operation
incubator-xtable copied to clipboard

Added a basic auto-setup script for mac os and some setup guides

Open amoghnatu opened this issue 2 months ago • 0 comments

Important Read

  • Please ensure the GitHub issue is mentioned at the beginning of the PR

What is the purpose of the pull request

(For example: This pull request implements the sync for delta format.) This PR adds a basic auto-setup script for mac os users. Additionally, it adds a setup guide, and a quick reference guide of useful commands, and provides explaination to some of the steps documented.

Brief change log

  • Adds a new setup-macos.sh file that automates setting up a development environment on mac os for XTable devs.
  • Adds MACOS_SETUP_GUIDE.md that explains each command used for setup. Can be used as a DIY guide for step-by-step setup.
  • Adds QUICK_REFERENCE.md for quick reference of useful commands
  • Adds a relevant README.md
  • Updated root README.md to reference to these new setup guides.

Verify this pull request

(Please pick either of the following options)

[x] This pull request is a trivial rework / code cleanup without any test coverage.

(or)

[ ] This pull request is already covered by existing tests, such as (please describe tests).

(or)

[ ] This change added tests and can be verified as follows:

(example:)

  • Added integration tests for end-to-end.
  • Added TestConversionController to verify the change.
  • Manually verified the change by running a job locally.

amoghnatu avatar Oct 02 '25 06:10 amoghnatu