Skip to content
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
6 changes: 2 additions & 4 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@ updates:
schedule:
interval: weekly
commit-message:
prefix: chore
include: scope
prefix: "chore(deps)"
labels:
- dependencies

Expand All @@ -15,7 +14,6 @@ updates:
schedule:
interval: weekly
commit-message:
prefix: ci
include: scope
prefix: "ci(actions)"
labels:
- dependencies
2 changes: 2 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
name: Checks

on:
pull_request:
branches: [master]
push:
branches: [master]

Expand Down
2 changes: 1 addition & 1 deletion Panels/Panel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
using Newtonsoft.Json;
using Panels.Elements;
using Panels.Utils;
using SixLabors.ImageSharp;
using System;
using System.Collections.Generic;
using System.Drawing;
using System.Globalization;
using System.IO;
using System.Xml;
Expand Down
1 change: 0 additions & 1 deletion Panels/Panels.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
<PackageReference Include="BouncyCastle.Cryptography" Version="2.6.2" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.4" />
<PackageReference Include="YamlDotNet" Version="16.3.0" />
<PackageReference Include="SixLabors.ImageSharp" Version="3.1.11" />
<PackageReference Include="System.CommandLine" Version="2.0.9" />
<PackageReference Include="System.Data.DataSetExtensions" Version="4.5.0" />
<PackageReference Include="System.Resources.Extensions" Version="5.0.0" />
Expand Down
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Panels

Panels is a CLI tool that allows exporting a comic book in PDF format from a configuration file (XML, JSON, or YAML) and a set of images.
A CLI tool that allows exporting a comic book in PDF format from a configuration file (XML, JSON, or YAML) and a set of images.

[![CI](https://github.com/samdouble/panels/actions/workflows/checks.yml/badge.svg)](https://github.com/samdouble/panels/actions/workflows/checks.yml)
[![CI](https://github.com/samdouble/panels/actions/workflows/checks.yml/badge.svg)](https://github.com/samdouble/panels/actions/workflows/checks.yml?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/samdouble/panels/badge.svg?branch=master)](https://coveralls.io/github/samdouble/panels?branch=master)
[![Release](https://img.shields.io/github/v/release/samdouble/panels)](https://github.com/samdouble/panels/releases/latest)
[![.NET](https://img.shields.io/badge/.NET-10.0-512BD4?logo=dotnet&logoColor=fff)](https://dotnet.microsoft.com/)
Expand All @@ -13,14 +13,15 @@ Panels is a CLI tool that allows exporting a comic book in PDF format from a con
[![XML](https://img.shields.io/badge/XML-767C52?logo=xml&logoColor=fff)](https://www.w3.org/XML/)
[![YAML](https://img.shields.io/badge/YAML-CB171E?logo=yaml&logoColor=fff)](https://yaml.org/)
[![NuGet](https://img.shields.io/badge/NuGet-004880?logo=nuget&logoColor=fff)](https://www.nuget.org/packages/Panels/)
[![Dependabot](https://img.shields.io/badge/Dependabot-025E8C?logo=dependabot&logoColor=fff)](https://github.com/security/advanced-security)

## Installation

### Linux

**Debian/Ubuntu**

Replace `VERSION` with the release version (e.g. `1.8.1`):
Replace `VERSION` with the release version (e.g. `2.0.0`):

```
curl -sL -o Panels.VERSION-amd64.deb https://github.com/samdouble/panels/releases/download/vVERSION/Panels.VERSION-amd64.deb
Expand Down Expand Up @@ -60,7 +61,7 @@ unzip Panels.VERSION-win-x64.zip
./Panels.exe --help
```

## How to Use
## Usage

### Command-line Commands & Arguments

Expand Down Expand Up @@ -202,24 +203,26 @@ Adds a description or narration to a panel. Attributes:

Forces a page break. Can be placed between slots.

### Migrating from 1.x to 2.x

- `maxPaddingLeft`, `maxPaddingRight`, `paddingBottom` and `paddingTop` now require to explicitly set the units as `%`. Simply add a `%` at the end of the value for these attributes.

## Development

### Running Locally

```
dotnet run --project Panels -- generate -c ~/Desktop/github_perso/bd/BD0/bd.xml -i ~/Desktop/github_perso/bd/BD0/images
dotnet run --project Panels -- generate -c ~/Desktop/github_perso/bd/BD00/bd.xml -i ~/Desktop/github_perso/bd/BD00/images
```

or:

```
dotnet build && ./Panels/bin/Debug/net10.0/Panels generate -c ~/Desktop/github_perso/bd/BD0/bd.xml -i ~/Desktop/github_perso/bd/BD0/images
dotnet build && ./Panels/bin/Debug/net10.0/Panels generate -c ~/Desktop/github_perso/bd/BD00/bd.xml -i ~/Desktop/github_perso/bd/BD00/images
```

### Running the tests

```
dotnet test
```

Coverage is collected automatically. The Cobertura report is written to `coverage/coverage.cobertura.xml`. The build fails if total line coverage drops below **75%** (configured in `Panels.Tests/Panels.Tests.csproj`).
Loading