image:https://github.com/metanorma/chocolatey-metanorma/workflows/main/badge.svg["Build Status", link="https://github.com/metanorma/chocolatey-metanorma/actions"] image:https://img.shields.io/chocolatey/v/metanorma.svg["Version", link="https://chocolatey.org/packages/metanorma"] image:https://img.shields.io/chocolatey/dt/metanorma.svg["Downloads", link="https://chocolatey.org/packages/metanorma"]

= chocolatey-metanorma: Chocolatey install for Metanorma

== Modifying the package

. Edit the metanorma.nuspec configuration file. . Edit the ./tools/chocolateyInstall.ps1 install script . Edit the ./tools/chocolateyUninstall.ps1 uninstall script . You must save your files with UTF-8 character encoding without BOM.

== Building the package

• Run choco pack in the same directory as metanorma.nuspec

NOTE: If you are running this from a command prompt/Powershell prompt, you must run it "as Administrator".

== Testing the package

NOTE: Testing should be done on a Virtual Machine (See: https://github.com/chocolatey/chocolatey-test-environment)

In the package directory, use:

• choco install metanorma -dv -s "'$pwd;https://chocolatey.org/api/v2/'" -f (Powershell)
• choco install metanorma -dv -s "'%cd%;https://chocolatey.org/api/v2/'" -f (everywhere else)

Or, use the full path:

• choco install metanorma -source 'c:\path\to\package' -f

After executing the install, ensure that metanorma.exe is installed by executing the following command from the command prompt:

[source,sh]

metanorma version

If it is properly installed, you will see the current version of Metanorma.

=== Testing uninstallation

NOTE: The Chocolatey install path on Windows is typically C:\ProgramData\chocolatey

Execute the following command to uninstall Metanorma.

[source,sh]

choco uninstall metanorma -y

After executing the uninstall ensure that metanorma is not found in the Chocolatey install path.

You can also try running metanorma version from the command-line to see if it is still installed

== Publish the package to the Chocolatey community feed repository

[source,sh]

choco apikey -k [API_KEY_HERE] -source https://chocolatey.org/`

package name can be omitted below

choco push metanorma.[version num].nupkg -s https://chocolatey.org/

== Installation from official repository

[source,sh]

choco install metanorma -y

or

[source,sh]

cinst metanorma -y

See the https://github.com/chocolatey/choco/wiki/CreatePackagesQuickStart[Chocolatey Packages Quick Start] for more information.