From 159b35bcab5269d1fe96db860482bd2f1363dc28 Mon Sep 17 00:00:00 2001 From: devZoGok Date: Sun, 13 Aug 2023 11:01:52 +0300 Subject: [PATCH 1/2] README --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1791a8f --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Battleship + +## Build guide + +### UNIX +- `git clone ` +- `cd Battteship` +- `git submodule update --init --recursive` +- `cmake -S . -B build` +- `cd build` +- `make` + +### Windows +- `git clone ` +- `cd Battteship` +- `git submodule update --init --recursive` +- `cmake -S . -B build -G ` +- open `build\ALL_BUILD.vcxproj` +- build the solution +- copy the DLLs, built from dependencies of `Battleship`, to the `build` subdirectory with `battleship.exe` + +## Contrib guide + +1. create an issue, representing a change you wish to implement using one of these labels: + * `feature` + * `improvement` + * `bugfix` +2. create a branch off the `develop` branch, named using this scheme: + * `feature` label -> `ft--` + * `improvement` label -> `imp--` + * `bugfix` label -> `bf--` +3. create a PR with a short description of changes and evidence of the issue resolved, such as: + * reference to an automatic test(s) to run + * steps to manually verify the issue is resolved + * screenshots or screencasts +4. await the repo admin's approval From 277897497fdccad5d9be0ba696b855feea3ffef7 Mon Sep 17 00:00:00 2001 From: devZoGok Date: Sun, 13 Aug 2023 11:09:47 +0300 Subject: [PATCH 2/2] additional line --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1791a8f..4ad77f9 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ - copy the DLLs, built from dependencies of `Battleship`, to the `build` subdirectory with `battleship.exe` ## Contrib guide +The Gitflow shall be used. 1. create an issue, representing a change you wish to implement using one of these labels: * `feature`