Skip to content

Commit

Permalink
Tweak documentation
Browse files Browse the repository at this point in the history
Vidyut is the Crate of the Week [1] and could use a stronger intro.

[1]: https://this-week-in-rust.org/blog/2025/01/15/this-week-in-rust-582/
  • Loading branch information
akprasad committed Jan 16, 2025
1 parent aa423e7 commit e0ed37d
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,6 @@ Spread the word

Vidyut is still a new project, and much of the Sanskrit ecosystem does not know
about it. If you know someone working on Sanskrit software, please let them
know that Vidyut exists and might help with some of their problems. Our hope is
that Vidyut will free programmers up to work on more interesting and ambitious
problems.
know that Vidyut exists and might help with some of their problems. Ultimately,
our hope is that Vidyut will give programmers the freedom and tools to work on
more interesting and ambitious projects.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,22 @@
<h1>विद्युत्</h1>
</div>

Vidyut provides reliable infrastructure for Sanskrit software.
Vidyut provides reliable infrastructure for Sanskrit software. Specifically,
Vidyut aims to provide performant and high-quality solutions for the common
problems that Sanskrit programmers face. Some of these problems include:

- *Transliteration*, or conversion of Sanskrit text from one script to another. (``भू````bhū``)

- *Word generation*, or converting bases and suffixes into complete words. (``भू````भवति``)

- *Word lookup*, or mapping a complete word back to its bases and suffixes. (``भवति````भू``)

- *Metrical analysis*, or understanding the meter used by a piece of Sanskrit text.

- *Sandhi changes*, or applying and undoing the sound changes that occur between pieces of
Sanskrit text.

- *Segmentation*, or splitting a piece of Sanskrit text into distinct words.

Vidyut compiles to fast and efficient native code, and it can be bound to other
programming languages with minimal work. We provide first-class support for
Expand Down

0 comments on commit e0ed37d

Please sign in to comment.