From cc4f67c3888a9e4279dd6167255e7c5c93be595b Mon Sep 17 00:00:00 2001 From: William Carroll Date: Sat, 12 Dec 2020 02:49:15 +0000 Subject: [PATCH] Add usage instructions to top-level README Also delete redundant `README` from `server` directory. --- assessments/semiprimes/README.md | 14 ++++++++++++++ assessments/semiprimes/server/README.md | 21 --------------------- 2 files changed, 14 insertions(+), 21 deletions(-) delete mode 100644 assessments/semiprimes/server/README.md diff --git a/assessments/semiprimes/README.md b/assessments/semiprimes/README.md index 9f676646c..7d5a15482 100644 --- a/assessments/semiprimes/README.md +++ b/assessments/semiprimes/README.md @@ -28,3 +28,17 @@ numbers *Semiprimes*. return the answer for all. - Considering this module will be used by a long running service, could you optimize it to give answers faster? + +## Usage + +To run the application you'll need to have `elixir` installed. Assuming `elixir` +is already installed, consult the following steps to start the application: + +```shell +$ cd server +$ mix deps.get +$ iex -S mix +``` + +Now open a web browser and visit `http://localhost:8080`! + diff --git a/assessments/semiprimes/server/README.md b/assessments/semiprimes/server/README.md deleted file mode 100644 index f5a7dad59..000000000 --- a/assessments/semiprimes/server/README.md +++ /dev/null @@ -1,21 +0,0 @@ -# Server - -**TODO: Add description** - -## Installation - -If [available in Hex](https://hex.pm/docs/publish), the package can be installed -by adding `server` to your list of dependencies in `mix.exs`: - -```elixir -def deps do - [ - {:server, "~> 0.1.0"} - ] -end -``` - -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at [https://hexdocs.pm/server](https://hexdocs.pm/server). -