Skip to content

Commit faceb79

Browse files
author
Bernard Pietraga
committed
Update readme for app form exercises 6 chapter 13
1 parent fb66fe5 commit faceb79

File tree

1 file changed

+54
-1
lines changed

1 file changed

+54
-1
lines changed

chapter_13/cracow_weather/README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,61 @@
11
# CracowWeather
22

3-
**TODO: Add description**
3+
This application is solution for exercise 6 of chapter 13 written in
4+
`Programming Elixir` by `Dave Thomas`. It allows user to quickly fetch weather
5+
data from Cracow, Poland and print it to terminal.
6+
7+
It is also executable Erlang Escript.
48

59
## Installation
10+
You need to have Elixir version `1.4` installed localy.
11+
12+
First download dependencies.
13+
```
14+
mix deps.get
15+
```
16+
17+
Than you can type run to compile
18+
```
19+
mix run
20+
```
21+
22+
## Usage via IEx
23+
Go to root path of this app.
24+
25+
Compile and load CracowWeather to Iex.
26+
```
27+
iex -S mix
28+
```
29+
30+
Print latest weather data to your terminal.
31+
```
32+
CracowWeather.CLI.main
33+
```
34+
35+
## Usage as a shell script via escript
36+
Make sure you have Erlang installed
37+
38+
Build fresh version of script
39+
```
40+
mix escript.build
41+
```
42+
43+
Run script via shell.
44+
```
45+
./cracow_weather
46+
```
47+
48+
## Tests
49+
To run tests simply type
50+
```
51+
mix test
52+
```
53+
54+
## Documentation
55+
To generate documentation via ex_doc please type
56+
```
57+
mix docs
58+
```
659

760
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
861
by adding `cracow_weather` to your list of dependencies in `mix.exs`:

0 commit comments

Comments
 (0)