Add building documentation

This commit is contained in:
Chaitanya Bisht 2024-02-27 20:05:04 +05:30
parent d77aca1e5e
commit 121fc7eb0f
No known key found for this signature in database
GPG Key ID: 6BCB259AF1D2A53D
1 changed files with 18 additions and 1 deletions

View File

@ -78,7 +78,24 @@ Primarily we just need the offending rpm file (best the smallest you can
find or we would soon take few GB to take a checkout) and some basic
expectation of what should happen.
### Example workflow
### Building the tool
This section focuses on how to build the tool as you develop it.
To build the tool, we'll use a tool called `packit`. First, install `packit` on your system:
dnf install packit
Then, build the project using:
packit build locally
If you encounter any errors, install the missing dependencies and run the same command again. Once the build is successful, you'll find a RPM file under the `noarch` directory. To install the package on your system, run:
dnf install <the_rpm_you_just_built>
Alternatively, the built binary can be found in the `rpmlint` directory under the `.packit` directory, which you can run directly.
### Example workflow for testing a functionality
1) I have rpmfile that should report unreadable zip file
2) I store this file in git under `test/binary/texlive-codepage-doc-2018.151.svn21126-38.1.noarch.rpm`