@gnu-mcu-eclipse/riscv-none-gcc/README.md

An xPack which installs the binary files for GNU MCU Eclipse RISC-V GCC

[![npm (scoped)](https://img.shields.io/npm/v/@gnu-mcu-eclipse/riscv-none-gcc.svg)](https://www.npmjs.com/package/@gnu-mcu-eclipse/riscv-none-gcc) 
[![license](https://img.shields.io/github/license/gnu-mcu-eclipse/riscv-none-gcc-xpack.svg)](https://github.com/gnu-mcu-eclipse/riscv-none-gcc-xpack/blob/xpack/LICENSE) 
[![Standard](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com/)


## The GNU MCU Eclipse RISC-V Embedded GCC binary xPack

This binary xPack installs the platform specific binaries for the
[GNU MCU Eclipse RISC-V Embedded GCC](https://github.com/gnu-mcu-eclipse/riscv-none-gcc)
toolchain.

The source files of the xPack project are publicly available from 
[GitHub](https://github.com/gnu-mcu-eclipse/riscv-none-gcc-xpack).

## How to use

This section is intended for developers who plan to use the 
RISC-V Embedded GCC toolchain.

### Prerequisites

The only requirement is a recent 
`xpm`, which is a portable 
[Node.js](https://nodejs.org) command line application. To install it,
follow the instructions from the 
[`xpm`](https://www.npmjs.com/package/xpm) page.

### Easy install

The xPack is available as 
[`@gnu-mcu-eclipse/riscv-none-gcc`](https://www.npmjs.com/package/gnu-mcu-eclipse/riscv-none-gcc)
from the public `npmjs.com` repository; with `xpm` available, installing 
the latest version of the package is quite easy:

```console
$ xpm install @gnu-mcu-eclipse/riscv-none-gcc --global
```

Global xPacks are always installed in the user home folder, even on GNU/Linux  
or macOS, and do not require `sudo`.

The GNU MCU Eclipse plug-ins automatically identify binaries installed with
`xpm` and provide a convenient method to manage paths.

To remove the installed xPack, the command is similar:

```console
$ xpm uninstall @gnu-mcu-eclipse/riscv-none-gcc --global
```

(Note: not yet implemented. As a temporary workaround, simply remove the 
`xPacks/@gnu-mcu-eclipse/riscv-none-gcc` folder, or the versions subfolders.)


## Developer info

### The xPack git repo

The few xPack source files are available from GitHub:

```console
$ git clone https://github.com/gnu-mcu-eclipse/riscv-none-gcc-xpack.git riscv-none-gcc-xpack.git
```

### Binary files

The binaries are not stored on the `npmjs.com` server, but are downloaded from  
the [releases](https://github.com/gnu-mcu-eclipse/riscv-none-gcc/releases) 
section of the `gnu-mcu-eclipse/riscv-none-gcc` GitHub project.

## Maintainer info

### How to publish

* open [releases](https://github.com/gnu-mcu-eclipse/riscv-none-gcc/releases) 
and select the latest release
* update the `baseUrl:` with the file URLs (including the tag/version)
* from the blog post, copy the SHA & file names
* commit all changes, use a message like `package.json: update urls for 8.2.0-2.1 release` (without `v`)
* update `CHANGELOG.md`; commit with a message like _CHANGELOG: prepare v8.2.0-2.1.1_
* `npm version 8.2.0-2.1.1`
* push all changes to GitHub
* `npm publish`

## License

The original content is released under the 
[MIT License](https://opensource.org/licenses/MIT), with all rights 
reserved to [Liviu Ionescu](https://github.com/ilg-ul).

The binary distributions include several open-source components; the
corresponding licenses are available in the `gnu-mcu-eclipse/licenses`
folder.