aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBryan Brattlof <hello@bryanbrattlof.com>2020-12-11 12:49:17 -0500
committerBryan Brattlof <hello@bryanbrattlof.com>2020-12-11 12:49:17 -0500
commit85351d531caa4eff23436bf252511af800eb8045 (patch)
tree6b5dbb70ff494935f8b665f3e58208d8794d1bd3
parentc0687dab88517cd8e67a39c20c29fabbd038a596 (diff)
downloadadvent-of-code-85351d531caa4eff23436bf252511af800eb8045.tar.gz
advent-of-code-85351d531caa4eff23436bf252511af800eb8045.tar.bz2
add 2020 readme
-rw-r--r--readme.rst84
1 files changed, 84 insertions, 0 deletions
diff --git a/readme.rst b/readme.rst
new file mode 100644
index 0000000..472a787
--- /dev/null
+++ b/readme.rst
@@ -0,0 +1,84 @@
+Advent of Code
+##############
+
+Hi! I'm `Eric Wastl <http://was.tl/>`__. I make Advent of Code. I hope you like
+it! I also made Vanilla JS, PHP Sadness, and lots of other things. You can find
+me on `Twitter <https://twitter.com/ericwastl>`__ and `GitHub
+<https://github.com/topaz>`__.
+
+Advent of Code is an Advent calendar of small programming puzzles for a variety
+of skill sets and skill levels that can be solved in any programming language
+you like. People use them as a speed contest, interview prep, company training,
+university coursework, practice problems, or to challenge each other.
+
+You don't need a computer science background to participate - just a little
+programming knowledge and some problem solving skills will get you pretty far.
+Nor do you need a fancy computer; every problem has a solution that completes in
+at most 15 seconds on ten-year-old hardware.
+
+If you'd like to support Advent of Code, you can do so indirectly by helping to
+[Share on Twitter Mastodon] it with others, or directly via `PayPal or Coinbase
+<https://adventofcode.com/2020/support>`__.
+
+Advent of Code is a registered trademark in the United States.
+
+General Tips
+############
+
+If you get stuck, try your solution against the examples given in the puzzle;
+you should get the same answers. If not, re-read the description. Did you
+misunderstand something? Is your program doing something you don't expect? After
+the examples work, if your answer still isn't correct, build some test cases for
+which you can verify the answer by hand and see if those work with your program.
+Make sure you have the entire puzzle input. If you're still stuck, maybe ask a
+friend for help, or come back to the puzzle later. You can also ask for hints in
+the subreddit.
+
+Frequently Asked Questions
+##########################
+
+Why was this puzzle so easy / hard? The difficulty and subject matter varies
+throughout each event. Very generally, the puzzles get more difficult over time,
+but your specific skillset will make each puzzle significantly easier or harder
+for you than someone else. Making puzzles is tricky.
+
+Why do the puzzles unlock at midnight EST/UTC-5? Because that's when I can
+consistently be available to make sure everything is working. I also have a
+family, a day job, and even need sleep occasionally. If you can't participate at
+midnight, that's not a problem; many people use private leaderboards to compete
+with people in their area.
+
+How does authentication work? Advent of Code uses OAuth to confirm your identity
+through other services. When you log in, you only ever give your credentials to
+that service - never to Advent of Code. Then, the service you use tells the
+Advent of Code servers that you're really you. In general, this reveals no
+information about you beyond what is already public; here are examples from
+Reddit and GitHub. Advent of Code will remember your unique ID, names, URL, and
+image from the service you use to authenticate.
+
+I find the text on the site hard to read. Is there a high contrast mode? There
+is a high contrast alternate stylesheet. Firefox supports these by default (View
+-> Page Style -> High Contrast).
+
+I have a puzzle idea! Can I send it to you? Please don't. Because of legal
+issues like copyright and attribution, I don't accept puzzle ideas, and I won't
+even read your email if it looks like one just in case I use parts of it by
+accident.
+
+Credits
+#######
+
+Puzzles, Code, & Design: `Eric Wastl <https://twitter.com/ericwastl>`__
+
+Beta Testing:
+
+- `Tim Giannetti <https://twitter.com/Sr_Giannetti>`__
+- Ben Lucek
+- `JP Burke <https://twitter.com/yatpay>`__
+- `Aneurysm9 <https://twitter.com/Aneurysm9>`__
+- Andrew Skalski
+
+Community Managers: `Danielle Lucek <https://www.reddit.com/user/daggerdragon>`__
+and `Aneurysm9 <https://twitter.com/Aneurysm9>`__
+
+Playing: You!