Move install info to README from separate file
This commit is contained in:
parent
c05470316b
commit
1cfdffcbd8
17
INSTALL
17
INSTALL
|
@ -1,17 +0,0 @@
|
|||
You need the following utilities to run rpmlint:
|
||||
o python 2.7 or newer
|
||||
o rpm and its python bindings
|
||||
o libmagic and its python bindings (optional)
|
||||
o readelf
|
||||
o cpio
|
||||
o desktop-file-validate
|
||||
o gzip, bzip2 and xz
|
||||
o groff and gtbl (optional)
|
||||
o enchant and its python bindings (optional)
|
||||
o appstream-util, part of appstream-glib (optional)
|
||||
|
||||
and the following programs to install it:
|
||||
o python 2.7 or newer
|
||||
o python-setuptools
|
||||
o rpm python bindings
|
||||
o pytest and pytest-flake8 (for running the test suite)
|
28
README.md
28
README.md
|
@ -20,19 +20,39 @@ checks and suggestions at:
|
|||
|
||||
https://github.com/rpm-software-management/rpmlint
|
||||
|
||||
# Testing
|
||||
## Install
|
||||
|
||||
For installation on your machine you will need following packages:
|
||||
|
||||
- Python 3.6 or newer
|
||||
- Python setuptoools
|
||||
- rpm and its python bindings
|
||||
- readelf, cpio, gzip, bzip and xz
|
||||
- libmagic and its python bindings (optional)
|
||||
- groff and gtbl (optional)
|
||||
- enchant and its python bindings (optional)
|
||||
- appstream-util, part of appstream-glib (optional)
|
||||
|
||||
## Testing
|
||||
|
||||
If you want to test the rpmlint when developing best is to use docker
|
||||
to provide the enviroment for you. There are various distribution
|
||||
dockerfiles in `test/` folder.
|
||||
|
||||
Ie. on openSUSE you can test using following commands.
|
||||
|
||||
First you build the docker enviroment:
|
||||
Ie. if you want to test on latest openSUSE you can test using following commands:
|
||||
|
||||
`docker build -t opensusetw -f test/Dockerfile-opensusetw .`
|
||||
|
||||
`docker run -v $(pwd):/usr/src/rpmlint/ opensusetw python3 setup.py test`
|
||||
|
||||
Another option is to run the tests on your system directly. If you
|
||||
have all the required modules as listed on the Install section above.
|
||||
You will also need `pytest` and `pytest-cov` and `pytest-flake8`.
|
||||
|
||||
If all the dependencies are present you can just execute tests using:
|
||||
|
||||
`python3 setup.py test`
|
||||
|
||||
## Configuration
|
||||
|
||||
If you want to change configuration options or the list of checks you can
|
||||
|
|
Loading…
Reference in New Issue