Christopher Cole
2ad70e5db2
Fix up README example so it compiles
...
Patch 9a6a265a forgot to update the old name of find_common_sections in the README, and since cargo test only compiles doc comments and
doesn't know about the README, I missed this.
Fixes #31
2023-02-20 18:28:11 -08:00
Christopher Cole
1181e6b70b
Reorder README/doc comment feature list
2023-02-15 15:21:13 -08:00
Christopher Cole
db0c3938a0
Rewrite docs section about unsafe code
...
This addresses feedback from #30
2023-02-09 01:44:38 -08:00
Christopher Cole
4bdcb7db5f
Rework the top level documentation a bit
2022-11-09 19:35:14 -08:00
Christopher Cole
cb987d1846
Update the README.md and top-level crate doc comment with new example
2022-11-06 14:33:50 -08:00
Christopher Cole
0873690791
Update the capabilities statements in the README.md
2022-11-04 18:13:00 -07:00
Christopher Cole
a010016831
Add documentation calling out this parser's is zero-alloc capability
2022-10-20 23:07:31 -07:00
Christopher Cole
1be248c4bb
Add default std feature to allow no_std use-cases
...
This addresses the ask in #19
2022-10-20 23:00:57 -07:00
Christopher Cole
7abba88d76
Fix up some copy-pasted rustdoc markdown in README.md
...
third time's a charm :)
2022-10-20 22:50:57 -07:00
Christopher Cole
3ffb08a11c
Remove typoed duplicate header in README.md
2022-10-20 22:48:28 -07:00
Christopher Cole
e9bc799ec7
Remove eager symbol table parsing from File::open_stream
...
Now, all section parsing is done lazily on-demand by the other File methods
Also, update README.md and lib.rs doc comment to reflect current library development state
2022-10-20 22:45:27 -07:00
Christopher Cole
90c7487760
Put the crate doc comment contents in the README as well
...
This makes it more accessible to those who are introduced to the crate on github
2022-10-15 17:36:07 -07:00
Christopher Cole
f9017e54b4
Remove File::get_section in favor of accessing pub sections data member
2022-10-13 15:22:21 -07:00
Christopher Cole
94305929e1
Update README.md example to use open_stream
2022-10-10 22:28:41 -07:00
Christopher Cole
1354885276
Use docs.rs for Documentation link in README.md
2022-10-03 12:33:37 -07:00
Christopher Cole
c772d63b93
Change README.md badges
...
Point them to github action results, crates.io, and docs.rs
2022-10-03 12:28:09 -07:00
Wilfred Hughes
a4416bc638
env is also unused
2016-10-08 11:00:30 -04:00
Wilfred Hughes
fa22515e06
Vec<u8> values cannot be printed
...
So show the debug format instead.
2016-10-08 00:03:13 -04:00
Christopher Cole
02863a2e9b
Update README.md example to reflect reality
2016-04-06 14:00:24 -07:00
Christopher Cole
049e584cc8
Add link to documentation in root README
2015-02-09 20:53:52 -08:00
Christopher Cole
adbbc42c4b
Update README to include File::get_section usage
2015-02-03 21:20:53 -08:00
Christopher Cole
3c95341d5c
Add elf::File struct to parse an on-disk ELF file
...
Currently only parses ELF32 File Headers.
2015-01-28 22:55:26 -08:00
Christopher Cole
2ba9481c14
Add travis-ci build badge to README.md
2015-01-26 21:50:21 -08:00
Christopher Cole
c8a55415df
Initial commit
2015-01-24 15:33:23 -08:00
