Skip to content

Commit ca30713

Browse files
committed
Further improve the README.md
1 parent 0b792e1 commit ca30713

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,21 @@
88

99
---
1010

11+
## Table of Contents
12+
13+
- [Overview](#overview)
14+
- [ELFIO: ELF Object and Executable File Reader/Writer](#elfio-elf-object-and-executable-file-readerwriter)
15+
- [ARIO: Advanced Archive Input/Output Library](#ario-advanced-archive-inputoutput-library)
16+
- [Getting Started](#getting-started)
17+
- [Who Uses ELFIO & ARIO?](#who-uses-elfio--ario)
18+
- [Contributing](#contributing)
19+
- [License](#license)
20+
- [Resources](#resources)
21+
- [Installation](#installation)
22+
- [Support](#support)
23+
24+
---
25+
1126
## Overview
1227

1328
**ELFIO** and **ARIO** are robust, header-only C++ libraries designed to make binary file and archive manipulation effortless, efficient, and portable. Whether you are building compilers, linkers, binary analysis tools, or custom build systems, these libraries provide the foundation you need for working with ELF files and UNIX archives.
@@ -117,4 +132,22 @@ This project is licensed under the [MIT License](https://github.com/serge1/ELFIO
117132

118133
---
119134

135+
## Project Structure
136+
137+
- `elfio/` — ELFIO header files
138+
- `ario/` — ARIO header files
139+
- `examples/` — Example usage and sample tools
140+
141+
---
142+
143+
## Installation
144+
145+
Simply copy the `elfio` and/or `ario` directories into your project and include the relevant headers. No build or linking steps are required.
146+
147+
---
148+
149+
## Support
150+
151+
For questions or support, please open an issue on [GitHub](https://github.com/serge1/ELFIO/issues).
152+
120153
*ELFIO and ARIO: Empowering your C++ binary and archive manipulation with simplicity, performance, and reliability!*

0 commit comments

Comments
 (0)