diff --git a/README.md b/README.md index 6e3e32a..22e9c8f 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,8 @@ [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/). @@ -13,13 +12,19 @@ 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 ```