Make README a little more friendly to beginners

This commit is contained in:
Zach Latta 2021-02-24 10:27:09 -05:00
parent d5312ac31c
commit 9b57113cfd

View file

@ -2,15 +2,33 @@
<h1 align="center"><a href="https://hackclub.com/">Hack Club v3 Site</a></h1>
<p align="center"><i>The source code for hackclub.com</i></p>
Our new website—powered by [Next.js] with [MDX], [Theme UI], & [Hack Club Theme].
Hack Club's new website. For new developers getting started, run the following in your terminal:
[next.js]: https://nextjs.org
[mdx]: https://mdxjs.com
[theme ui]: https://theme-ui.com
[hack club theme]: https://theme.hackclub.com
Download the code to your computer:
$ git clone https://github.com/hackclub/v3
Install dependencies:
$ yarn
Start running the wbsite on your computer:
$ yarn run dev
And then open up your web browser and go to http://localhost:3000.
Please note: There are a number of redirects and rewrites essential to the website's functionality, which you can see in `next.config.js`.
Powered by [Next.js] with [MDX], [Theme UI], & [Hack Club Theme].
Code under MIT License, assets may not be re-used or re-distributed.
---
By [@lachlanjc](https://lachlanjc.com) for Hack Club, 2020. MIT License.
[next.js]: https://nextjs.org
[mdx]: https://mdxjs.com
[theme ui]: https://theme-ui.com
[hack club theme]: https://theme.hackclub.com