From c08db48f24530b9721531a702c8f49100b4f00dd Mon Sep 17 00:00:00 2001 From: Justin Worthe Date: Sat, 15 Dec 2018 16:05:46 +0200 Subject: Code housekeeping: Added a readme --- LICENSE | 21 --------------------- license.org | 21 +++++++++++++++++++++ readme.org | 38 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 59 insertions(+), 21 deletions(-) delete mode 100644 LICENSE create mode 100644 license.org create mode 100644 readme.org diff --git a/LICENSE b/LICENSE deleted file mode 100644 index d3e83ae..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 Justin Worthe - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/license.org b/license.org new file mode 100644 index 0000000..8d31e87 --- /dev/null +++ b/license.org @@ -0,0 +1,21 @@ +* The MIT License + +Copyright (c) 2018 Justin Worthe + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/readme.org b/readme.org new file mode 100644 index 0000000..7fe82e4 --- /dev/null +++ b/readme.org @@ -0,0 +1,38 @@ +* Advent of Code 2018 + +** What is Advent of Code? + +Advent of Code is a programming advent calendar. On the 25 days of +December leading up to Christmas, each morning a new programming +challenge is unlocked. The race is then on to see who can solve the +challenge and get the answer to their particular input first. + +It's a lot of fun. I have my solutions posted here so that I can share +them with my friends, as well as the broader community if they're +interested. + +** A note on error handling and code quality + +The only important metric to consider in terms of taking the Advent of +Code challenges seriously from a competitive point of view is how +quickly you arrive at an answer for your particular input. + +These solutions should not in any way be seen as an example of good +coding standards in Rust. The error handling in particular is +appalling. The reason for this is that I can look at the input data +and be certain that some error cases won't come up, like empty +lists. I can also assume that things like file system access will +always work because I'm only running it on my machine under my +supervision. + +When my assumptions are wrong, the program panics and dies, but I'm +currently there programming it when it's running so that isn't really +a big deal. + +The short version of what I'm trying to say is that even though I use +~unwrap~ all over the place in this particular repo, I still think +it's a really bad idea to use it in a real project. + +** License + +See [[./license.org]]. -- cgit v1.2.3