Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ndinata committed Jun 3, 2024
1 parent fe9d7a9 commit fd7fe6e
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,23 +3,28 @@
[mantram.blog](https://mantram.blog/) is a mobile-friendly library/compilation of
various Buddhist mantrams/suttas (真言).

I ([ndinata](https://github.com/ndinata)) built this site so that my family and
friends have an easier time reciting mantrams on their phones. No more having to
zoom in and out of blurry photos of book pages!
I built this site so that my family and friends have an easier time reciting mantrams
on their phones. No more having to zoom in and out of blurry photos of book pages!

All the mantrams are available as Markdown files in [src/content/posts](./src/content/posts/).

For suggestions/corrections feel free to open an issue or email me :)

## tech stack

The site is built with the lovely [Astro](https://astro.build) framework and React + [shadcn](https://ui.shadcn.com) UI components, and is deployed on GitHub Pages.
The site is built with the lovely [Astro](https://astro.build) framework and
React + [shadcn](https://ui.shadcn.com) UI components, and is deployed on GitHub Pages.
The [mantram parser](./mantram-parser/) is implemented in Rust (exposed via Wasm).

To run it locally:
To run the project locally, you need to have the following installed:

- [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
- [rust toolchain](https://www.rust-lang.org/tools/install) + [`wasm-pack`](https://rustwasm.github.io/wasm-pack/installer/)

```sh
$ git clone https://github.com/avid-sh/mantram.git
$ git clone https://github.com/ndinata/mantram.git
$ cd mantram
$ wasm-pack build mantram-parser
$ npm install
$ npm run dev # starts a localhost dev server
```

0 comments on commit fd7fe6e

Please sign in to comment.