11 Commits

Author SHA1 Message Date
Igor Opaniuk
7206903f43 README: move info about man pages to a separate section
Since manual pages can be generated on all systems
(Linux, Mac, Windows(MSYS)), move this step to a separate section.

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
2025-11-20 12:57:22 +01:00
Igor Opaniuk
6b4a0adc3c README: add git to Windows build instructions
In [1] the git package is listed as a required package, add it to
the build instructions for Windows.

[1] commit 09a4f034b0 ("github: Get --version working for Windows build")
Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
2025-11-20 12:39:44 +01:00
Bjorn Andersson
57b7b56ebe README: Document the multi-image support
Document the three new mechanisms for providing multiple Sahara images
to QDL, in order to handle targets that needs to download multiple
images in order to enter Firehose mode.

Signed-off-by: Bjorn Andersson <bjorn.andersson@oss.qualcomm.com>
2025-11-18 15:10:03 -06:00
Roger Shimizu
0a3c1175bd Add 'manpages' as new target to generate manpages by help2man
* Makefile: `make manpages` generates the manpages.
* Makefile: `make clean` purges the generated manpages.
* .gitignore: Add generated manpages files.
* README.md: Add description how to make manpages for Linux.

Signed-off-by: Roger Shimizu <rosh@debian.org>
2025-11-18 14:24:02 -06:00
Bjorn Andersson
3433cd77c3 README: Add blank lines around code blocks
markdownlink requires that there are blank rounds around code blocks.

Signed-off-by: Bjorn Andersson <bjorn.andersson@oss.qualcomm.com>
2025-11-11 09:09:38 -06:00
Amit Kucheria
92b14a1c58 Add build instructions for MacPorts
Mac users use Homebrew or MacPorts to get their "unix" tools. 

Add instructions to build on MacPorts users.

Signed-off-by: Amit Kucheria <amit.kucheria@oss.qualcomm.com>
2025-10-24 08:08:32 -05:00
Bjorn Andersson
dad8b4802d qdl: Document the newly introduced read and write commands
Add documentation and usage for the newly introduced read and write
commands.

Signed-off-by: Bjorn Andersson <bjorn.andersson@oss.qualcomm.com>
2025-09-09 16:18:12 -05:00
Sam Freund
cd32723503 Fix linux command to install libusb
Signed-off-by: Sam Freund <techguy763@gmail.com>
2025-07-04 15:02:54 +02:00
Igor Opaniuk
3250ce0026 README: add details about contribution and license
1. Add build/license badges.
2. Add details about contribution workflow and "make check-cached"
   usage.
3. Fix make cmd description for Windows.
4. Add details about running tests.

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
2025-06-25 15:42:39 +02:00
Igor Opaniuk
7bdf416118 README: extend list of packages for Windows
Install "base-devel" package as well, which provides diff/cmp/make
tools.
Suggest to use "make" instead of "mingw32-make".

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
2025-06-24 14:26:25 +02:00
Igor Opaniuk
54da7531ea README: extend existing readme
Convert the existing README to Markdown format and expand it with build
instructions and usage examples.

Signed-off-by: Igor Opaniuk <igor.opaniuk@oss.qualcomm.com>
2025-06-23 13:33:16 -05:00