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

[PLAT-7776] Prepare repo for public #121

Merged
merged 1 commit into from
Jan 4, 2022
Merged

Conversation

nickdowell
Copy link
Contributor

Goal

Prepare repo to be made public.

Changeset

Adds README, LICENSE, and GitHub support info & issue templates (all adapted from existing public repos)

Testing

N/A

The top level of this repository contains an example project which uses the Bugsnag plugin - [`BugsnagExample.uproject`](BugsnagExample.uproject).

To build the example project for Android or iOS, you must first run `make` in the top level directory to prepare the dependencies.
This step requires macOS with the Android NDK & SDK and Xcode.

Choose a reason for hiding this comment

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

Worth mentioning versions?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I wasn't intending this to be a "how to set up your development environment" section - that would need its own document - and I'm not sure what the versions requirements actually are. Perhaps we should just remove this line?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think its worthwhile just to have the line for folks who might try to build for one platform not realizing the full build requires both android and iOS set up. Probably not worth any version requirements since the build works with the latest of each (in the event that one or the other platform is missing and you need to grab the installer).

@nickdowell nickdowell merged commit 5ec0183 into next Jan 4, 2022
@nickdowell nickdowell deleted the nickdowell/prepare-repo branch January 4, 2022 13:47
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

3 participants