From 1967974f006322672da6a67bbf5f15ea67eb9675 Mon Sep 17 00:00:00 2001 From: Michael R Sweet Date: Sun, 30 May 2021 10:22:56 -0400 Subject: [PATCH] Add Github workflow/sponsor info. --- .github/FUNDING.yml | 10 +++++++ .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++ .github/workflows/build.yml | 36 +++++++++++++++++++++++ README.md | 8 ++--- 5 files changed, 102 insertions(+), 4 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/workflows/build.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..9b51d7f --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,10 @@ +github: michaelrsweet +#patreon: # Replace with a single Patreon username +#open_collective: # Replace with a single Open Collective username +#ko_fi: # Replace with a single Ko-fi username +#tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel +#community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry +liberapay: michaelrsweet +#issuehunt: # Replace with a single IssueHunt username +#otechie: # Replace with a single Otechie username +#custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..0ccdbc3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**System Information:** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b7a1210 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,36 @@ +name: Build + +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +jobs: + build-linux: + + runs-on: ubuntu-20.04 + + steps: + - uses: actions/checkout@v2 + - name: update build environment + run: sudo apt-get update --fix-missing -y + - name: install prerequisites + run: sudo apt-get install -y zlib1g-dev + - name: make + run: make 'COMMONFLAGS="-g -fsanitize=address"' + - name: test + env: + ASAN_OPTIONS: leak_check_at_exit=false + run: make test + + build-macos: + + runs-on: macos-latest + + steps: + - uses: actions/checkout@v2 + - name: make + run: make 'COMMONFLAGS="-g -fsanitize=address"' + - name: test + run: make test diff --git a/README.md b/README.md index 6d0bb9e..484be6c 100644 --- a/README.md +++ b/README.md @@ -4,10 +4,10 @@ pdfio - PDF Read/Write Library PDFio is a simple C library for reading and writing PDF files. The primary goals of PDFio are: -- Read and write any version of PDF file. -- Provide access to pages, objects, and streams within a PDF file. -- Support reading encrypted PDF files. -- Support writing PDF files with digital signatures. +- Read and write any version of PDF file +- Provide access to pages, objects, and streams within a PDF file +- Support reading encrypted PDF files +- Support writing PDF files with digital signatures - Extract or embed useful metadata (author, creator, page information, etc.) - "Filter" PDF files, for example to extract a range of pages or to embed fonts that are missing from a PDF