Browse Source

Added readme

dhasenan 4 years ago
parent
commit
c67b6acf81
1 changed files with 47 additions and 0 deletions
  1. 47
    0
      README.md

+ 47
- 0
README.md View File

@@ -0,0 +1,47 @@
1
+# Dub Auto Tester
2
+
3
+This project simply takes every dub package available on `code.dlang.org` and tests each version
4
+against each DMD release. It keeps track of the results and crafts HTML reports.
5
+
6
+**A failure in the tester does not indicate a project that does not work.** See the Limitations
7
+section below. This system exists to give a quick impression of what D versions are best to use for
8
+what projects, and what D versions are generally most compatible with the ecosystem at large.
9
+
10
+[See current results here!](http://ikeran.org/report/index.html)
11
+
12
+## Running it on your own
13
+
14
+You will need:
15
+
16
+* sqlite libraries to link against
17
+* dub
18
+* dmd or the equivalent
19
+
20
+This is currently being developed with dmd 2.081.1.
21
+
22
+
23
+## Limitations
24
+
25
+* The tester only tests full release versions -- vX.Y.Z.
26
+    * It doesn't test prereleases, like 0.17.4-alpha3.
27
+    * It doesn't test branches like ~master.
28
+* The tester only takes the most recent three versions.
29
+    * The backfill is missing a lot of versions.
30
+    * If you push five versions in a row, the tester might miss some.
31
+    * This limitation may be removed in a later version.
32
+* The tester only tests one platform -- Linux on amd64. A lot of packages might work just fine on
33
+  their intended platforms but fail on the tester.
34
+* An arbitrary selection of libraries is available on the build machine. This might cause some
35
+  things not to build.
36
+
37
+
38
+## Build badges
39
+
40
+The auto tester has build badges. Here's an example:
41
+
42
+<img src="http://ikeran.org/report/package/buffer.svg" width="100" height="40" />
43
+
44
+This indicates the most recent contiguous range of D versions that at least one version of the
45
+package can build and pass tests on.
46
+
47
+Dunno why you'd want it, but I made it.