From 9b57113cfda1c75106eb6f53f083d651ca3806da Mon Sep 17 00:00:00 2001 From: Zach Latta Date: Wed, 24 Feb 2021 10:27:09 -0500 Subject: [PATCH] Make README a little more friendly to beginners --- README.md | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 82f667cf..ec39677e 100755 --- a/README.md +++ b/README.md @@ -2,15 +2,33 @@

Hack Club v3 Site

The source code for hackclub.com

-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