mirror of
https://github.com/wader/fq.git
synced 2024-11-23 09:56:07 +03:00
doc: Fix typo and some improvments
This commit is contained in:
parent
93322bc434
commit
1a0089e351
18
README.md
18
README.md
@ -6,14 +6,18 @@ Tool, language and format decoders for exploring binary data.
|
|||||||
|
|
||||||
## Goals
|
## Goals
|
||||||
|
|
||||||
- Make binary formats accessible any queryable.
|
- Make binary formats accessible and queryable.
|
||||||
- Nested formats and bit-oriented decoding.
|
- Nested formats and bit-oriented decoding.
|
||||||
- Quick and comfortable CLI tool.
|
- Quick and comfortable CLI tool.
|
||||||
- Do bit and byte transformations and conversions.
|
- Bit and byte transformations and conversions.
|
||||||
- Programmer's calculator.
|
- Programmer's calculator.
|
||||||
|
|
||||||
**NOTE:** fq is early in development and many things are missing, broken or do not make sense. That also means there is a great opportunity to help out.
|
**NOTE:** fq is early in development and many things are missing, broken or do not make sense. That also means there is a great opportunity to help out.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
Basic usage is: `fq . file`. For details see [usage.md](doc/usage.md).
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
Download archive from [releases](https://github.com/wader/fq/releases) page for your
|
Download archive from [releases](https://github.com/wader/fq/releases) page for your
|
||||||
@ -49,10 +53,6 @@ make test fq
|
|||||||
cp fq /usr/local/bin
|
cp fq /usr/local/bin
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Basic usage is `fq . file`. For more details see [usage.md](doc/usage.md).
|
|
||||||
|
|
||||||
## Supported formats
|
## Supported formats
|
||||||
|
|
||||||
[./formats_list.jq]: sh-start
|
[./formats_list.jq]: sh-start
|
||||||
@ -61,15 +61,15 @@ aac_frame, adts, adts_frame, apev2, av1_ccr, av1_frame, av1_obu, avc_annexb, avc
|
|||||||
|
|
||||||
[#]: sh-end
|
[#]: sh-end
|
||||||
|
|
||||||
See [formats](doc/formats.md) for more details.
|
For details see [formats.md](doc/formats.md).
|
||||||
|
|
||||||
## TODO and ideas
|
## TODO and ideas
|
||||||
|
|
||||||
See [TODO.md](doc/TODO.md)
|
See [TODO.md](doc/TODO.md).
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
See [dev.md](doc/dev.md)
|
See [dev.md](doc/dev.md).
|
||||||
|
|
||||||
## Thanks and related projects
|
## Thanks and related projects
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user