naps2/NAPS2.Tools
2022-10-31 22:05:41 -07:00
..
Localization Sane paper source options 2022-09-09 22:06:12 -07:00
Project More output on share command 2022-10-31 22:05:41 -07:00
.gitignore Add a NAPS2.Tools n2-config.json file for configuring the share dir 2022-10-30 15:55:25 -07:00
app.config Create a generic NAPS2.Tools project for various commands, starting with "n2 clean" 2022-07-04 16:50:12 -07:00
Cli.cs Gtk: Flatpak package/install tools 2022-10-30 15:32:25 -07:00
N2Config.cs Add a NAPS2.Tools n2-config.json file for configuring the share dir 2022-10-30 15:55:25 -07:00
NAPS2.Tools.csproj Implement saneopts tool to auto-generate SaneOptionTranslations file 2022-09-08 19:50:30 -07:00
Paths.cs Add a NAPS2.Tools n2-config.json file for configuring the share dir 2022-10-30 15:55:25 -07:00
Program.cs Implement mac packaging and a new share command 2022-10-23 17:23:18 -07:00
README.md Update tools doc 2022-10-23 17:35:04 -07:00

NAPS2.Tools

Tools for NAPS2 building, testing, packaging, verification, etc.

How to run

You will need the latest .NET SDK. Open a terminal in your NAPS2 solution directory and run the following commands:

Powershell

function n2 { dotnet run -p:LangVersion=preview --project NAPS2.Tools -- $args }
n2 build all

Bash

alias n2="dotnet run -p:LangVersion=preview --project NAPS2.Tools --"
n2 build all

Commands

Run n2 help for a full list of commands and n2 help <command> for all options for a particular command. Some examples:

n2 clean
n2 test
n2 build exe
n2 pkg exe
n2 verify exe
n2 publish exe
n2 virus exe
n2 share
  • clean: Clear out bin/obj subfolders
  • test: Run solution tests
  • build: Builds the solution with the specified configuration (debug/exe/msi/zip/all)
  • pkg: Generates the specified package type, e.g. exe => naps2-{version}-win-x64.exe installer
  • verify: Installs/extracts the packaged file and runs NAPS2.App.Tests against it
    • Requires elevation for exe/msi as it does a real install on your local machine (and uninstalls the old NAPS2)
  • publish: Runs a series of commands: clean, test, build, pkg, verify
  • virus: Uploads a package to VirusTotal for a false positive check
  • share: Syncs local packages with a cloud folder (to help with cross-platform packaging)