diff --git a/README.md b/README.md index 1b85905..fd11343 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ # 86Box assets repository -This repository contains all ROMs needed by the [86Box](https://github.com/86Box/86Box) emulator. For development versions of 86Box, the recommended way to use this repository is to clone it instead of downloading the tagged releases. +This repository contains all assets needed by the [86Box](https://github.com/86Box/86Box) emulator. For development versions of 86Box, the recommended way to use this repository is to clone it instead of downloading the tagged releases. Note that some assets in this repository may be for dev-branched machines and devices, meaning that they will not do anything on regular release builds. If you are confused why some device does not appear despite the asset being present in the set, check that you are using an appropriate build of 86Box before reporting issues. ## Contributing assets Before new assets can be accepted in this repository, the code that uses the assets needs to be in the upstream 86Box repository. Once you've made an 86Box pull request, open a pull request here. This applies to removals as well in inverse. -Note that your ROM(s) will not be merged to master until the code is in 86Box master. However, if the development is happening in an upstream 86Box branch, a corresponding branch can be created here until the feature is ready for master. +Note that your asset(s) will not be merged to master until the code is in 86Box master. However, if the development is happening in an upstream 86Box branch, a corresponding branch can be created here until the feature is ready for master. ## Committing guidelines - Do not use vague commit messages.