docs: expand README with project overview and getting started
This commit is contained in:
@@ -1,3 +1,26 @@
|
|||||||
# la-huasca-ts
|
# la-huasca-ts
|
||||||
|
|
||||||
TypeScript + Next.js version of La Huasca
|
TypeScript + Next.js version of La Huasca.
|
||||||
|
|
||||||
|
A minimal Next.js 14+ App Router scaffold using TypeScript, with [`@chenglou/pretext`](https://github.com/chenglou/pretext) installed. The landing page demonstrates a Pretext-based text measurement in a client component (`src/components/MeasuredText.tsx`).
|
||||||
|
|
||||||
|
## Getting started
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm install
|
||||||
|
npm run dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Open [http://localhost:3000](http://localhost:3000).
|
||||||
|
|
||||||
|
## Project structure
|
||||||
|
|
||||||
|
```
|
||||||
|
package.json
|
||||||
|
next.config.js
|
||||||
|
tsconfig.json
|
||||||
|
src/app/layout.tsx
|
||||||
|
src/app/page.tsx
|
||||||
|
src/components/MeasuredText.tsx
|
||||||
|
README.md
|
||||||
|
```
|
||||||
|
|||||||
Reference in New Issue
Block a user