Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 2.15 KB

README.md

File metadata and controls

50 lines (32 loc) · 2.15 KB

Yuorb

Introduction

Yuorb is a website that provides a multilingual S·T·I (Signification, Translation, Interpretation) service of the New Ithkuil grammar. The website also includes a number of other resources for learning New Ithkuil, such as a dictionary and a grammar guide.

Furthermore, this repository offers a communal revision of the New Ithkuil Grammar with the purpose of detecting and rectifying inaccuracies found in the official website’s explanations, as well as addressing discrepancies in the functioning of New Ithkuil.

Features

  • Translation of the New Ithkuil grammar
  • Dictionary of New Ithkuil terms
  • Grammar guide for New Ithkuil
  • Forum for discussing New Ithkuil

Installation

Yuorb is a web-based application, so there is no need to install it. Simply visit the website at https://yuorb.github.io/ to get started.

Usage

To use Yuorb, simply browse the website and explore the different resources that are available. You can use the dictionary to look up the meaning of New Ithkuil terms, or you can use the grammar guide to learn more about the grammar of the language. You can also discuss New Ithkuil with other learners in the Discord server.

Contributing

Yuorb is an open source project, and contributions are welcome. If you would like to contribute to the project, please visit the GitHub repository at https://github.com/yuorb/yuorb.github.io.

License

Yuorb project is released under the MIT License.

The translated text and any documents themselves are licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

Build

Use pnpm as your package manager.

Setup via CLI

  1. First, fork the repo and clone it.
  2. Navigate to the directory.

Run the following command to install the necessary packages:

pnpm install

To start the development server, run the following command:

pnpm docs:dev

VuePress will initiate a hot-reloading development server accessible at http://localhost:8080. Any modifications made to your markdown files will automatically update the content in the browser.