diff --git a/README.md b/README.md index a9b2718..2facdfd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,17 @@ -This repository contains Godot project, to test regression with engine. +## Godot regression test project +This repository contains Godot project which aims to be tested in official Godot repository. -It creates and add to scene every single node. +Due using by Godot Vulkan API, it is not currently possible to run editor or project inside CI(either it's and this). -For now it use only nodes with default parameters(they are add instantly after creating - add_node(Sprite.new())), but it should add as much parameters as possible. +Godot 3.2 uses GLES 2/3 which are available in CI, so project for this branch is developed here https://github.com/qarmin/RegressionTestProject/tree/3.2. + +## Contributions +Contributions are welcome. + +Main development are for now focused in 3.2 branch of this project and there you should look at the code and write a new one or fix old one. + +But still I will add some small(or maybe even big) code pieces to master branch, but since it need to be manually checked and run, it may take some time before I merge it to master branch. + +## Epilepsy Warning +Due using by project a lot of functions from each type of Node, screen may flicker, images and objects may change randomly color and size which may lead some users to health problems. -Project shouldn't use too much randomize functions, because reproducing bugs would be a madness.