about summary refs log tree commit diff
path: root/assessments
diff options
context:
space:
mode:
authorWilliam Carroll <wpcarro@gmail.com>2020-12-12T02·49+0000
committerWilliam Carroll <wpcarro@gmail.com>2020-12-12T02·49+0000
commitcc4f67c3888a9e4279dd6167255e7c5c93be595b (patch)
treeaaac3e8b807f291b487d4fd35a53ba8e646e73d1 /assessments
parent8c5e4e77edacf082b5ab2d8aede49aa0ddfb9b5e (diff)
Add usage instructions to top-level README
Also delete redundant `README` from `server` directory.
Diffstat (limited to 'assessments')
-rw-r--r--assessments/semiprimes/README.md14
-rw-r--r--assessments/semiprimes/server/README.md21
2 files changed, 14 insertions, 21 deletions
diff --git a/assessments/semiprimes/README.md b/assessments/semiprimes/README.md
index 9f676646c2a8..7d5a15482ab3 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 f5a7dad599fc..000000000000
--- 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).
-