readme

README.md

@@ -1,34 +1,13 @@
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+# UTF Inspector
-
+
-## Getting Started
+A web interface for [utfdump](https://github.com/pantonshire/utfdump/), using
-
+Next.js and WebAssembly.
-First, run the development server:
+
-
+## Building & running
-```bash
+1. Install [`Rust Cargo`](https://www.rust-lang.org/),
-npm run dev
+   [`wasm-pack`](https://github.com/rustwasm/wasm-pack) and
-# or
+   [`npm`](https://www.npmjs.com/)
-yarn dev
+2. `git submodule update --init`
-# or
+3. `npm install`
-pnpm dev
+4. `npm run build`
-```
+5. `npm run start`
-
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
-
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
-
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
-
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.