@iitm_shakti/devices/README.md

An xPack with the µOS++ support for the Shakti devices

To Do
## Shakti device specific files

This project provides support for Shakti RISC-V based microcontrollers.

## Developer info

This section is intended to developers who plan to include this library in their own projects.

### Prerequisites

A recent [`xpm`](https://www.npmjs.com/package/xpm), which is a portable [Node.js](https://nodejs.org/) command line application.

Compiling the source code requires a modern C++ compiler, preferably GCC 5 or higher. 

### Easy install

This package is available as [`@iitm_shakti/devices`](https://www.npmjs.com/package/@iitm_shakti/devices) from the `npmjs.com` registry; with `xpm` available, installing the latest version of the package is quite easy:

```console
$ xpm install @iitm_shakti/devices
```

This package is also available from [GitLab](https://gitlab.com/shaktiproject/software/shakti-devices-xpack.git):

```console
$ git clone https://gitlab.com/shaktiproject/software/shakti-devices-xpack.git shakti-devices-xpack.git
```

### How to use

The standard way to include the device files is

```c
#include <micro-os-plus/device.h>
```

### Macros

* `SHAKTI_CARTY100T`
* `SHAKTI_EARTY35T`

### Known problems

* the `os_terminate()` function is not fully implemented, it must use either the Watchdog or PMU+RTC to trigger a system reset.

## Maintainer info

### How to publish

* commit all changes
* update `CHANGELOG.md`; commit with a message like _CHANGELOG: prepare v0.1.2_
* `npm version patch`
* push all changes to GitLab
* `npm publish`

## License

TODO