Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correct Readme.md and ci.yml #41

Merged
merged 2 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 25 additions & 23 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,27 +43,29 @@ jobs:
name: build-windows
runs-on: windows-latest
steps:
- uses: actions/checkout@v1
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Get latest CMake
uses: lukka/get-cmake@latest
- name: Installing Jinja2
run: python -m pip install Jinja2
- name: List python modules
run: pip list
- name: Installing pytest
run: python -m pip install pytest
- name: Running cmake (Windows)
run: |
cmake -DCMAKE_BUILD_TYPE=Debug .
- name: Build Solution (Windows)
run: |
cmake --build .
- name: Testing (Windows)
run: |
ctest -C Debug --output-on-failure


- uses: actions/checkout@v1
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Get latest CMake
uses: lukka/get-cmake@latest
- name: Installing Jinja2
run: python -m pip install Jinja2
- name: List python modules
run: pip list
- name: Installing pytest
run: python -m pip install pytest
- name: Running cmake (Windows)
run: |
New-Item build -ItemType Directory
cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
- name: Build Solution (Windows)
run: |
cd build
cmake --build .
- name: Testing (Windows)
run: |
cd build
ctest -C Debug --output-on-failure

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,8 @@ ASALocalRun/
# BeatPulse healthcheck temp database
healthchecksdb

build

Pin
out
/code_generator/just_for_cmake.cpp
Expand Down
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,37 @@ First clone the repository.

Then, go inside the repository then configure and build the project and finally run the tests.

To do so, run via your command line on Linux or your powershell on Windows:
## Installation for Linux

Run via your command line on Linux :

```shell
cd [PENE repository]
mkdir build
cd build
cmake -DCMAKE_BUILD_TYPE=Debug ..
make
ctest -C Debug --output-on-failure
```

## Installation for Windows

Run via your command line on your powershell on Windows :

```shell
cd [PENE repository]
cmake .
New-Item build -ItemType Directory
cd build

##runing cmake
cmake -DCMAKE_BUILD_TYPE=Debug ..

##build solution
cmake --build .
ctest -C Debug

##Testing
ctest -C Debug --output-on-failure
```
On Linux, you can create a folder, then generate and build the project inside it.

You can also install the tool via a code editor.

Expand Down
Loading