Skip to content

Commit

Permalink
version 1.0 (#38)
Browse files Browse the repository at this point in the history
* Switched entirely to CMake
* Updated README - added usage tutorial, compiler support and licence info, updated dev notes
* Small doc comments changes
* Added `g++`, `clang` and `test` workflows
  • Loading branch information
SpectraL519 committed Feb 9, 2024
1 parent ed41eb0 commit c2a4251
Show file tree
Hide file tree
Showing 20 changed files with 703 additions and 495 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/gpp.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: g++
on:
push:
branches:
- '*'
pull_request:
branches:
- master

jobs:
build:
name: Build examples
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Build
shell: bash
env:
CC: gcc-11
CXX: g++-11
run: |
cd example
cmake -B build -DCMAKE_CXX_COMPILER=g++-11
cd build
make
continue-on-error: false
39 changes: 39 additions & 0 deletions .github/workflows/test.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: test
on:
push:
branches:
- '*'
pull_request:
branches:
- master

jobs:
build_and_test:
name: Build and Test
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v2

- name: Prepare
run: |
cd test
cmake -B build -DCMAKE_CXX_COMPILER=g++-11
continue-on-error: false

- name: Build test executable
shell: bash
env:
CC: gcc-11
CXX: g++-11
run: |
cd test/build
make
continue-on-error: false

- name: Run tests
run: |
cd test/build
./test
continue-on-error: false
6 changes: 2 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,9 @@

# build files
*.exe
test/out/*
test/test
log/*
test/cmake/*
!test/cmake/.gitkeep
test/build/
example/build/

# documentation files
/documentation
6 changes: 3 additions & 3 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -42,19 +42,19 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Argument Parser for C++20"
PROJECT_NAME = "CPP-AP"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.

PROJECT_NUMBER =
PROJECT_NUMBER = 1.0

# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.

PROJECT_BRIEF =
PROJECT_BRIEF = "Command-line argument parser for C++20"

# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
Expand Down
Loading

0 comments on commit c2a4251

Please sign in to comment.