Skip to content

Commit c7402bb

Browse files
committed
[doc] Improve documentation
Signed-off-by: Douglas Reis <doreis@lowrisc.org>
1 parent 70d90b7 commit c7402bb

1 file changed

Lines changed: 41 additions & 8 deletions

File tree

README.md

Lines changed: 41 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,58 @@
1-
# Ftditool is a C++ implementation for SPI/I2C Flash memory communication leveraging FTDI MPSSE-enabled chips.
1+
# ftditool: A C++ implementation for SPI Flash and GPIO leveraging FTDI MPSSE-enabled chips.
22

3-
The FT4222 is supported for fast qSPI transactions.
3+
`ftditool` supports **SPI** and **GPIO** over **FT4222** and **FT2232** chips. The FT4222 specifically supports fast **QSPI** transactions.
44

5-
## Getting started
6-
Build:
5+
## Getting Started
6+
7+
Install the dependencies using Nix or any other method:
8+
9+
```sh
10+
nix develop
711
```
12+
13+
### Build:
14+
```bash
815
cmake -B build -S ./ && cmake --build build
916
```
10-
Run with --help argument for more information:
17+
18+
### Usage:
19+
20+
Run with the `--help` argument for more information:
21+
1122
```sh
1223
build/ftditool --help
1324
```
14-
Read jedec:
25+
26+
**Read JEDEC ID:**
27+
1528
```sh
1629
build/ftditool jedec
1730
```
18-
Read page 0x800:
31+
32+
**Read page 0x8000:**
33+
1934
```sh
2035
build/ftditool read-page --addr 0x8000
2136
```
2237

23-
## Dependency graph
38+
For a full list of commands:
39+
40+
```sh
41+
build/ftditool --help
42+
```
43+
44+
For an example of a real-world application of `ftditool`, check out the [mocha](https://github.com/lowRISC/mocha/blob/main/util/fpga_runner.py) repository.
45+
46+
## Nix
47+
48+
`ftditool` can be easily installed using **Nix**:
49+
50+
```sh
51+
nix shell github:lowrisc/ftditool
52+
```
53+
----
54+
55+
## Development
56+
### Dependency graph
2457
![Dependency graph](doc/img/deps.png)
2558

0 commit comments

Comments
 (0)