Skip to content

Commit da7b8f5

Browse files
Minor documentation updates (#628)
* Make 3C documentation easier to find from the root readme. * 3C build instructions: Clarify the working directory.
1 parent 91db852 commit da7b8f5

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,10 +62,14 @@ For more information on Checked C and pointers to example code, see our
6262
## 3C: Semi-automated conversion of C code to Checked C
6363

6464
This repository includes a tool called 3C that partially automates the
65-
conversion of C code to Checked C. Here is [general information about the 3C
66-
software](clang/docs/checkedc/3C/README.md), including development status and
67-
how to contribute. Here are the [usage instructions for the `3c` command-line
68-
tool](clang/tools/3c/README.md).
65+
conversion of C code to Checked C. Quick documentation links:
66+
67+
* [General information](clang/docs/checkedc/3C/README.md), including development
68+
status and how to contribute
69+
70+
* [Build instructions](clang/docs/checkedc/3C/INSTALL.md)
71+
72+
* [Usage instructions for the `3c` command-line tool](clang/tools/3c/README.md)
6973

7074
## More information
7175

clang/docs/checkedc/3C/INSTALL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ https://github.com/correctcomputation/checkedc-clang or
2525
https://github.com/microsoft/checkedc-clang (or, of course, a
2626
third-party fork, though we can't be responsible for that). Assuming
2727
you have already cloned one of these repositories, run the following
28-
(from the root of the working tree) for a basic build:
28+
(from the `checkedc-clang` directory or whatever you named your clone)
29+
for a basic build:
2930

3031
```
3132
# Get a copy of the Checked C system headers. Use Microsoft's

0 commit comments

Comments
 (0)