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 build docs #110

Merged
merged 2 commits into from
Jul 23, 2023
Merged

add build docs #110

merged 2 commits into from
Jul 23, 2023

Conversation

pjfanning
Copy link
Contributor

  • basic build notes
  • far from complete but possibly enough to tide over someone who just wants to basic build verification

@pjfanning
Copy link
Contributor Author

@mdedetrich I added this in anticipation of an imminent RC

Copy link
Member

@He-Pin He-Pin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm


### Running the Build
- Open a command window and change directory to your preferred base directory
- Use git to clone the [repo](https://github.com/apache/incubator-pekko-connectors-kafka) or download a source release from https://pekko.apache.org (and unzip or untar it, as appropriate)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

git repo address instead?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the sentence already says Use git, I'm not sure it is a good idea to say git repo. I think most people would infer thet repo is a git repo. It doesn't read well read to repeat the same word multiple times in a sentence.

@pjfanning pjfanning merged commit 2bb6d94 into main Jul 23, 2023
13 of 14 checks passed
@pjfanning pjfanning deleted the build-docs branch July 23, 2023 10:53
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.

None yet

2 participants