kristoferssolo/testing-spring-2024
1
0
Fork 0
mirror of https://github.com/jorenchik/testing-spring-2024.git synced 2025-10-21 20:10:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(readme): update description

Browse Source
This commit is contained in:
Kristofers Solo 2024-03-14 03:42:50 +02:00
parent 72b89de4ce
commit 3406744872
2 changed files with 27 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README-lv.md
View File

@ -5,20 +5,21 @@
## Projekts ## Projekts
Šis ir vienkāršs C++ projekts, kas ietver funkciju mūsu kolēģiem Šis ir vienkāršs C++ projekts, kas ietver funkciju mūsu kolēģiem
testēšanai. Funkcija (t.i., galvenā funkcija un tajā izmantotās apakšfunkcijas) testēšanai. Funkcija, t.i., apakšfunkcijas, kuru nepieciešams testēt
atrodas `lib.cpp`. atrodas `validation.cc`.
## Papildu bibliotēkas un izpildāmā programma ## Papildu bibliotēkas un izpildāmā programma
Mūsu bibliotēka `prep` ir saistīta ar datu sagatavošanu pirms funkcijas Direktorija `modules` ir saistīta ar datu sagatavošanu pirms funkcijas
izsaukuma. `test.cpp` ir viens testa fails, kurā būs mūsu kolēģu testi izsaukuma. `test_validation.cc` ir viens testa fails, kas satur testus.
un mūsu pašu izstrādes testi. GTest tiek izmantots testiem. [GTest](https://github.com/google/googletest) tiek izmantots testiem.
## Lietojums ## Lietojums
## Kompilācija uz Linux un MacOS ## Kompilācija uz Linux un MacOS
Kompilācijai operētājsistēmā Linux ir nepieciešams cmake un CXX kompilators (e.g., g++). Kompilācijai operētājsistēmā Linux ir nepieciešams cmake un
CXX kompilators (e.g., g++).
### MacOS ### MacOS
@ -59,10 +60,15 @@ make
### Windows un/vai VSCode ### Windows un/vai VSCode
Uzstādiet [CMake](https://cmake.org/download/) un VSCode [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) paplašinājumu. Uzstādiet [CMake](https://cmake.org/download/) un VSCode
[CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools)
paplašinājumu.
- Atveriet projektu kā saknes direktoriju VSCode. - Atveriet projektu kā saknes direktoriju
- Izvēlaties **View->Command palete...** vai `Ctrl+Shift+P` un palaidiet `CMake: Build`. VSCode.
- Izvēlaties **View->Command palete...** vai
`Ctrl+Shift+P` un palaidiet `CMake: Build`.
Rezultātā iegūtie binārie faili ir `build/main` - programma un `build/runtests`, lai Rezultātā iegūtie binārie faili ir `build/main` -- programma un
palaistu punktos norādītos testus iekš `test.cpp`. `build/test_validation`, lai palaistu norādītos testus
no `test_validation.cc` faila.

17
README.md
View File

@ -7,14 +7,14 @@
## Project ## Project
This is a simple C++ project that includes the function for our colleagues to This is a simple C++ project that includes the function for our colleagues to
test. The function (i.e., the main function and the subfunctions used in it) is test. The function (i.e., the subfunctions that are used in main function) is
located in `lib.cpp`. located in `validation.cc`.
## Additional libraries and executable ## Additional libraries and executable
Our library `prep` is concerned with preparation of data prior to the function Directory `modules` is concerned with preparation of data prior to the function
call. `test.cpp` is a single test file that will contain the tests of our colleagues call. `test_validation.cc` is a single test file that contain the tests.
and our own development tests. GTest is used for tests. [GTest](https://github.com/google/googletest) is used for tests.
## Usage ## Usage
@ -61,9 +61,12 @@ make
### Windows and/or VSCode ### Windows and/or VSCode
Install [CMake](https://cmake.org/download/) and VSCode [CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools) extension. Install [CMake](https://cmake.org/download/) and VSCode
[CMake Tools](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cmake-tools)
extension.
- Open project as root in VSCode. - Open project as root in VSCode.
- Press **View->Command palette...** or `Ctrl+Shift+P` and run `CMake: Build`. - Press **View->Command palette...** or `Ctrl+Shift+P` and run `CMake: Build`.
Resulting binaries are `build/main` -- the program and `build/runtests` to run tests specified in `test.cpp`. Resulting binaries are `build/main` -- the program and `build/test_validation`
to run tests specified in `test_validation.cc`.