pashto-inflector/README.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

2021-03-09 12:39:13 +00:00
# pashto-inflector
2022-11-08 06:07:40 +00:00
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
2021-03-09 12:39:13 +00:00
[![Netlify Status](https://api.netlify.com/api/v1/badges/ca3a7720-876f-4375-a77e-2e7bfdcee48a/deploy-status)](https://app.netlify.com/sites/pashto-verbs/deploys)
2021-04-30 16:30:50 +00:00
![build](https://github.com/lingdocs/pashto-inflector/actions/workflows/ci.yml/badge.svg)
![build](https://github.com/lingdocs/pashto-inflector/actions/workflows/publish.yml/badge.svg)
2021-03-09 12:39:13 +00:00
2023-02-22 18:02:16 +00:00
A pashto inflection, verb conjugation, and phrase-generation engine, as well as functions and components for modifying and displaying Pashto text.
2021-03-09 12:39:13 +00:00
2022-11-08 06:09:21 +00:00
#### [Pashto Inflector Website/Demo](https://pashto-inflector.lingdocs.com)
2021-03-09 12:39:13 +00:00
2022-11-08 06:08:40 +00:00
This is **published as two libraries**:
2022-10-09 10:03:13 +00:00
2022-10-24 08:19:01 +00:00
- @lingdocs/inflect
- `/src/components`
2022-10-09 10:03:13 +00:00
- The core inflection engine with grammatical information and tools for processing LingDocs dictionary entries and Pashto text.
2022-10-09 10:07:21 +00:00
- Can be used with Node 16, as CommonJS
2022-10-09 10:03:13 +00:00
- @lingdocs/ps-react
2022-10-24 08:19:01 +00:00
- `/src/lib`
2022-10-09 10:03:13 +00:00
- @lingdocs/inflect plus react components for displaying Pashto text, phrase engine UI etc.
2022-10-09 10:07:21 +00:00
- Only available as an ES6 Module
2023-01-26 13:00:11 +00:00
`@lingdocs/pashto-inflector` **is deprecated**. Use `@lingdocs/inflect` or `@lingdocs/ps-react` instead.
2022-10-09 10:03:13 +00:00
2021-03-09 12:39:13 +00:00
## Development
The Pashto Verb Explorer website can be used to view and play with the verb conjugations and various components.
```
yarn install
2021-03-09 12:39:13 +00:00
yarn start
```
## Building
2021-03-10 17:50:45 +00:00
⚠ Don't use `yarn build`. Use one of the commands below: ⚠
2021-03-09 12:39:13 +00:00
### Website
2021-03-09 13:20:55 +00:00
To build the [Pashto Verb Explorer](https://verbs.lingdocs.com) website:
2021-03-09 12:39:13 +00:00
```
yarn build-website
```
This outputs a site at `/build`
2022-10-09 10:03:13 +00:00
### Libraries
2021-03-09 12:39:13 +00:00
2022-10-09 10:03:13 +00:00
To build the `@lingdocs/inflet` and `@lingdocs/ps-react` libraries ready for publishing to NPM:
2021-03-09 12:39:13 +00:00
```
yarn build-library
```