diff --git a/README.md b/README.md index c403366..e1aa08c 100644 --- a/README.md +++ b/README.md @@ -1,36 +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). +# REGISTRY ## Getting Started -First, run the development server: +The content generated for this app is gotten from [bitcointanscripts](https://github.com/bitcointranscripts/bitcointranscripts). -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +We employ a git submodule in the public folder to keep this material up to date. -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +## To run this locally -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. +- Pull down everything using `git clone --recurse-submodules` rather than the standard `git clone` because of the transcript data gotten from submodules. +- Install necessary dependencies using `npm install` or `npm i` +- Run the local development server `npm run dev`