Revamp README.md

This commit is contained in:
Xevion
2022-12-17 23:33:39 -06:00
parent d6c77c4c68
commit 707a01176e

View File

@@ -1,28 +1,14 @@
# Create T3 App
# [100prisoners][deployment]
This is a [T3 Stack](https://create.t3.gg/) project bootstrapped with `create-t3-app`.
A small Next.js app for exploring the famous [100 prisoners problem][wikipedia] devised by [Peter Bro Miltersen][peter-bro-miltersen].
## What's next? How do I make an app with this?
The goal of this application is to
- Explain the problem & solution in simple and easy to understand ways
- Provide a visually compelling system to show how the problem & solution works.
- Be aesthetically pleasing while attempting to support both Mobile & Desktop viewports.
We try to keep this project as simple as possible, so you can start with just the scaffolding we set up for you, and add additional things later when they become necessary.
The latest deployment can be found [here][deployment].
If you are not familiar with the different technologies used in this project, please refer to the respective docs. If you still are in the wind, please join our [Discord](https://t3.gg/discord) and ask for help.
- [Next.js](https://nextjs.org)
- [NextAuth.js](https://next-auth.js.org)
- [Prisma](https://prisma.io)
- [Tailwind CSS](https://tailwindcss.com)
- [tRPC](https://trpc.io)
## Learn More
To learn more about the [T3 Stack](https://create.t3.gg/), take a look at the following resources:
- [Documentation](https://create.t3.gg/)
- [Learn the T3 Stack](https://create.t3.gg/en/faq#what-learning-resources-are-currently-available) — Check out these awesome tutorials
You can check out the [create-t3-app GitHub repository](https://github.com/t3-oss/create-t3-app) — your feedback and contributions are welcome!
## How do I deploy this?
Follow our deployment guides for [Vercel](https://create.t3.gg/en/deployment/vercel) and [Docker](https://create.t3.gg/en/deployment/docker) for more information.
[deployment]: https://100prisoners.xevion.dev
[peter-bro-miltersen]: https://scholar.google.com/citations?user=0za9d6AAAAAJ&hl=en
[wikipedia]: https://en.wikipedia.org/wiki/100_prisoners_problem