From 831ddde1c6835a7b2f93f1e1e05049a8b394d407 Mon Sep 17 00:00:00 2001 From: Nelson Date: Fri, 29 Jan 2021 23:41:10 -0700 Subject: [PATCH] refactor readme --- elixir/GildedRoseRequirements.txt | 38 ---------------------------- elixir/README.md | 42 +++++++++++++++++++++++++++++++ 2 files changed, 42 insertions(+), 38 deletions(-) delete mode 100644 elixir/GildedRoseRequirements.txt diff --git a/elixir/GildedRoseRequirements.txt b/elixir/GildedRoseRequirements.txt deleted file mode 100644 index 5090a67a..00000000 --- a/elixir/GildedRoseRequirements.txt +++ /dev/null @@ -1,38 +0,0 @@ -====================================== -Gilded Rose Requirements Specification -====================================== - -Hi and welcome to team Gilded Rose. As you know, we are a small inn with a prime location in a -prominent city ran by a friendly innkeeper named Allison. We also buy and sell only the finest goods. -Unfortunately, our goods are constantly degrading in quality as they approach their sell by date. We -have a system in place that updates our inventory for us. It was developed by a no-nonsense type named -Leeroy, who has moved on to new adventures. Your task is to add the new feature to our system so that -we can begin selling a new category of items. First an introduction to our system: - - - All items have a SellIn value which denotes the number of days we have to sell the item - - All items have a Quality value which denotes how valuable the item is - - At the end of each day our system lowers both values for every item - -Pretty simple, right? Well this is where it gets interesting: - - - Once the sell by date has passed, Quality degrades twice as fast - - The Quality of an item is never negative - - "Aged Brie" actually increases in Quality the older it gets - - The Quality of an item is never more than 50 - - "Sulfuras", being a legendary item, never has to be sold or decreases in Quality - - "Backstage passes", like aged brie, increases in Quality as its SellIn value approaches; - Quality increases by 2 when there are 10 days or less and by 3 when there are 5 days or less but - Quality drops to 0 after the concert - -We have recently signed a supplier of conjured items. This requires an update to our system: - - - "Conjured" items degrade in Quality twice as fast as normal items - -Feel free to make any changes to the UpdateQuality method and add any new code as long as everything -still works correctly. However, do not alter the Item class or Items property as those belong to the -goblin in the corner who will insta-rage and one-shot you as he doesn't believe in shared code -ownership (you can make the UpdateQuality method and Items property static if you like, we'll cover -for you). - -Just for clarification, an item can never have its Quality increase above 50, however "Sulfuras" is a -legendary item and as such its Quality is 80 and it never alters. \ No newline at end of file diff --git a/elixir/README.md b/elixir/README.md index c7bf5d72..25f2ac88 100644 --- a/elixir/README.md +++ b/elixir/README.md @@ -1,3 +1,45 @@ +## Requirements + +====================================== +Gilded Rose Requirements Specification +====================================== + +Hi and welcome to team Gilded Rose. As you know, we are a small inn with a prime location in a +prominent city ran by a friendly innkeeper named Allison. We also buy and sell only the finest goods. +Unfortunately, our goods are constantly degrading in quality as they approach their sell by date. We +have a system in place that updates our inventory for us. It was developed by a no-nonsense type named +Leeroy, who has moved on to new adventures. Your task is to add the new feature to our system so that +we can begin selling a new category of items. First an introduction to our system: + + - All items have a SellIn value which denotes the number of days we have to sell the item + - All items have a Quality value which denotes how valuable the item is + - At the end of each day our system lowers both values for every item + +Pretty simple, right? Well this is where it gets interesting: + + - Once the sell by date has passed, Quality degrades twice as fast + - The Quality of an item is never negative + - "Aged Brie" actually increases in Quality the older it gets + - The Quality of an item is never more than 50 + - "Sulfuras", being a legendary item, never has to be sold or decreases in Quality + - "Backstage passes", like aged brie, increases in Quality as its SellIn value approaches; + Quality increases by 2 when there are 10 days or less and by 3 when there are 5 days or less but + Quality drops to 0 after the concert + +We have recently signed a supplier of conjured items. This requires an update to our system: + + - "Conjured" items degrade in Quality twice as fast as normal items + +Feel free to make any changes to the UpdateQuality method and add any new code as long as everything +still works correctly. However, do not alter the Item class or Items property as those belong to the +goblin in the corner who will insta-rage and one-shot you as he doesn't believe in shared code +ownership (you can make the UpdateQuality method and Items property static if you like, we'll cover +for you). + +Just for clarification, an item can never have its Quality increase above 50, however "Sulfuras" is a +legendary item and as such its Quality is 80 and it never alters. + + ## Tests `mix test`