diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4bf538b84b0211ada593913a556f10be0d6ed608..a0693d564438ece97e0e9bebc7262bf189a337d4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ # Contributing If you want to contribute to VirtualFluids, your help is very welcome. -To contribute use a pull request as follows: +To contribute use a merge request as follows: -### How to make a clean pull request +### How to make a clean merge request - Create a personal fork of VirtualFluids. -- Clone the fork on your local machine. Your remote repo on gitea is called `origin`. +- Clone the fork on your local machine. Your remote repo on gitlab is called `origin`. - Add the original repository as a remote called `upstream`. - If you created your fork a while ago be sure to pull upstream changes into your local repository. - Create a new branch to work on! Branch from `develop` or `open_source`. @@ -16,10 +16,10 @@ To contribute use a pull request as follows: - Write or adapt tests as needed. - Add or change the documentation as needed. - Push your branch to your fork on gitea, the remote `origin`. -- From your fork open a pull request in the correct branch. Target the project's `develop` or `open_source` branch +- From your fork open a merge request in the correct branch. Target the project's `develop` or `open_source` branch - … -- If we requests further changes just push them to your branch. The PR will be updated automatically. -- Once the pull request is approved and merged you can pull the changes from `upstream` to your local repo and delete +- If we requests further changes just push them to your branch. The MR will be updated automatically. +- Once the merge request is approved and merged you can pull the changes from `upstream` to your local repo and delete your extra branch(es). And last but not least: Always write your commit messages in the present tense. Your commit message should describe what the commit, when applied, does to the code – not what you did to the code. diff --git a/README.md b/README.md index 615e4d758e95b4b556efee9f9487beaf08d90d21..dcd9c19d6ed9a2254cb021904c3cfd982ad237e8 100644 --- a/README.md +++ b/README.md @@ -11,8 +11,8 @@ VirtualFluids has been used on a variety of platforms: - Cygwin ### Software Requirements - - [CMake](https://cmake.org/) (minimum version 3.13) - - C++ compiler with C++11 support, for example gcc 6.3 or Visual C++ 14.0 + - [CMake](https://cmake.org/) (minimum version 3.15) + - C++ compiler with C++14 support - [Paraview](https://www.paraview.org/) (most recent version) with usage of the GPU: @@ -62,9 +62,7 @@ The doxygen generated documentation can be found [here](https://git.irmb.bau.tu- ## Known Issues -If CMake does not find CUDA_CUT_INCLUDE_DIR use and set the correct CUDA Pathes in gpu.cmake in the base directory in lines 35, 36. - -If you notice any problems on your platform, please report an gitea issue. +If you notice any problems on your platform, please report an issue. ## Authors