aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: da5431a5f97beea7eaead5b5b927e57c78c5d9e0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# Trains

Trains is a simple web app to display train timetables for specific lines at stations on France SNCF's network. It records weekly passages and you can subscribe to certain train times to alert when schedules change or your stop is removed. It queries the SNCF official api and present the results in a minimal web page that loads fast (unlike the official sites with all their images and ads).

## Content

- [Dependencies](#dependencies)
- [Building](#building)
- [Usage](#usage)

## Dependencies

go is required. Only go version >= 1.16 on linux amd64 (Gentoo and Ubuntu 20.04) and on OpenBSD amd64 has been tested.

## Building

To run tests, use :
```
go test -cover ./...
```

For a debug build, use :
```
go build
```

For a release build, use :
```
go build -ldflags="-s -w"
```

## Usage

TODO