forked from adamrehn/ue4-docker
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Remove all info about ue4-engine * Remove docs about prebuilt ue4-build-prerequisites * Format command docs as mapages
- Loading branch information
1 parent
d384589
commit 55191a7
Showing
55 changed files
with
1,425 additions
and
1,199 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
= Guidelines for contributing to ue4-docker | ||
:icons: font | ||
:idprefix: | ||
:idseparator: - | ||
:source-highlighter: rouge | ||
:toc: | ||
|
||
== Creating issues | ||
|
||
When creating an issue to report a bug, please follow the provided issue template. | ||
Make sure you include the full output of the `ue4-docker info` command in the provided section, as well as the full output of the `ue4-docker build` command and the command line parameters used to invoke the build if you are reporting a problem with building the container images. | ||
|
||
If you are creating an issue for a feature request, you can disregard the default issue template. | ||
However, please make sure you have thoroughly read https://docs.adamrehn.com/ue4-docker/[the documentation] to ensure the requested feature does not already exist before creating an issue. | ||
|
||
== Creating pull requests | ||
|
||
Before creating a pull request, please ensure sure you have tested your changes on all platforms to which the change applies (Linux / Windows Server / Windows 10 / macOS). | ||
|
||
== Autoformatting your changes | ||
|
||
ue4-docker uses https://github.com/psf/black[Black] for its code formatting. | ||
If you are submitting changes, make sure to install and run Black: | ||
|
||
* `pip install --user black` | ||
* `python -m black .` (invoke in repository root) | ||
* Now your code is properly formatted |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
= Unreal Engine 4 Docker Containers | ||
|
||
image:https://raw.githubusercontent.com/adamrehn/ue4-docker/master/resources/images/banner.svg?sanitize=true[Unreal Engine and Docker Logos,align="center"] | ||
|
||
*Looking for a place to start? | ||
Check out the https://unrealcontainers.com/[Unreal Containers community hub] for implementation-agnostic information on using the Unreal Engine inside Docker containers, and then head to the https://docs.adamrehn.com/ue4-docker/[comprehensive ue4-docker documentation] to view details specific to using the ue4-docker project.* | ||
|
||
The ue4-docker Python package contains a set of Dockerfiles and accompanying build infrastructure that allows you to build Docker images for Epic Games' https://www.unrealengine.com/[Unreal Engine 4]. | ||
The images also incorporate the infrastructure from https://github.com/adamrehn/ue4cli[ue4cli], https://github.com/adamrehn/conan-ue4cli[conan-ue4cli], and https://github.com/adamrehn/ue4-ci-helpers[ue4-ci-helpers] to facilitate a wide variety of use cases. | ||
|
||
Key features include: | ||
|
||
* Unreal Engine 4.20.0 and newer is supported. | ||
* Both Windows containers and Linux containers are supported. | ||
* Building and packaging UE4 projects is supported. | ||
* Running automation tests is supported. | ||
* Running built UE4 projects with offscreen rendering is supported via NVIDIA Docker under Linux. | ||
Resources: | ||
|
||
* *Documentation:* https://docs.adamrehn.com/ue4-docker/ | ||
* *GitHub repository:* https://github.com/adamrehn/ue4-docker | ||
* *Package on PyPI:* https://pypi.org/project/ue4-docker/ | ||
* *Related articles:* https://adamrehn.com/articles/tag/Unreal%20Engine/ | ||
* *Unreal Containers community hub:* https://unrealcontainers.com/ | ||
* *Development channel on the Unreal Containers Community Discord server*: https://discord.gg/46CJg9fyJ9 | ||
== Contributing | ||
|
||
See the file https://github.com/adamrehn/ue4-docker/blob/master/CONTRIBUTING.md[CONTRIBUTING.md] for guidelines on how to contribute to the development of ue4-docker. | ||
|
||
== Legal | ||
|
||
Copyright © 2018 - 2022, Adam Rehn. | ||
Licensed under the MIT License, see the file https://github.com/adamrehn/ue4-docker/blob/master/LICENSE[LICENSE] for details. | ||
|
||
Unreal and its logo are Epic Games' trademarks or registered trademarks in the US and elsewhere. | ||
|
||
Docker and the Docker logo are trademarks or registered trademarks of Docker in the United States and other countries. |
Oops, something went wrong.