Skip to content

Commit d1e3eea

Browse files
committed
docs: improve README content
Add a flat list of supported debugging platforms. This should aide users looking to see if a particular platform is supported by DS2. Clarify that regsgen2 and libjson are not distributed as part of the DS2 distribution. Add a small blurb indicating that contributions are welcome.
1 parent 7ed1dda commit d1e3eea

File tree

1 file changed

+56
-1
lines changed

1 file changed

+56
-1
lines changed

README.md

+56-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,58 @@
11
# ds2
22

3-
ds2 is a debug server designed to be used with [LLDB](http://lldb.llvm.org/) to perform remote debugging of Linux, Android, FreeBSD, Windows targets.
3+
ds2 is a debug server designed to be used with [LLDB](http://lldb.llvm.org/) to
4+
perform remote debugging of Linux, Android, FreeBSD, Windows targets.
5+
6+
### Platform Support
7+
8+
There is varying support for different platforms. While not all the possible
9+
platforms are under CI coverage, DS2 has been known to run on the following
10+
platforms at various times.
11+
12+
- [x] Anrdoid
13+
- [x] ARM64
14+
- [x] ARMv7
15+
- [x] X64
16+
- [x] X86
17+
18+
- [x] Darwin
19+
- [ ] ARM64
20+
- [x] X64
21+
- [x] X86
22+
23+
- [x] FreeBSD
24+
- [x] X64
25+
- [x] X86
26+
27+
- [x] Linux
28+
- [x] ARM64
29+
- [x] ARMv7
30+
- [x] RISCV64
31+
- [x] X64
32+
- [x] X86
33+
34+
- [x] MinGW
35+
- [ ] ARM64
36+
- [x] ARMv7
37+
- [x] X64
38+
- [x] X86
39+
40+
- [-] Tizen
41+
- [x] ARMv7
42+
- [x] X86
43+
44+
- [x] Windows
45+
- [ ] ARM64
46+
- [x] ARMv7
47+
- [x] X64
48+
- [x] X86
49+
50+
### Contributing
51+
52+
Patches are welcome to fix issues on existing platforms as well as to improve
53+
coverage of existing or new platforms. For CI coverage, patches to increase
54+
coverage under GitHub Actions or to migrate coverage from CircleCI are also
55+
welcome.
456

557
### Documentation
658
- [Android](Documentation/Android.md)
@@ -18,3 +70,6 @@ regsgen2, a tool used to generate register definitions is also licensed under
1870
the University of Illinois/NCSA Open Source License and uses a json library
1971
licensed under the Boost Software License. A complete copy of the latter can be
2072
found in `Tools/libjson/LICENSE_1_0.txt`.
73+
74+
Note that neither regsgen2 nor libjson are part of the ds2 distribution itself,
75+
but rather are used to generate code that is included in ds2.

0 commit comments

Comments
 (0)