Skip to content

Commit 0e8d408

Browse files
committed
Update TOC
1 parent 335b1e9 commit 0e8d408

File tree

2 files changed

+17
-13
lines changed

2 files changed

+17
-13
lines changed

doc/README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
1+
# CacheSim Documentation
12

2-
## Main tools
3-
* [cachesim](quickstart_cachesim.md)
4-
* [trace utils](quickstart_traceUtils.md)
5-
* [trace analysis](quickstart_traceAnalysis.md)
3+
## Quickstart Guides
4+
- [CacheSim: Command-line cache simulator](quickstart_cachesim.md)
5+
- [Trace Utilities](quickstart_traceUtils.md)
6+
- [Trace Analyzer](quickstart_traceAnalyzer.md)
7+
- [MRC Profiler](quickstart_mrcProfiler.md)
8+
- [Plugin System](quickstart_plugin.md)
69

7-
## Using libCacheSim as a library
8-
* [library](lib.md)
9-
* [add a new algorithm](lib_extend.md)
10-
* [API](lib_api.md)
11-
12-
13-
## Benchmarks
14-
* [benchmarks](quickstart_benchmarks.md)
10+
## Advanced Usage
11+
- [Library Usage Guide](advanced_lib.md)
12+
- [How to Add a New Algorithm](advanced_lib_extend.md)
13+
- [API Reference (C)](API.md)
14+
- [Performance Tuning](performance.md)
15+
- [Memory Usage Profiling](memory_usage_profiling.md)
1516

17+
## Developer Documentation
18+
- [Debugging Guide](debug.md)
19+
- [Install & Build](install.md)

doc/quickstart_plugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ For Python examples, see the `libCacheSim-python/README.md` file which contains
302302
* **Custom Cache Issues**: Validate your custom implementation against built-in algorithms using test functions.
303303
* **Implementation Issues**: When re-implementing an eviction algorithm in libCacheSim using the plugin system, note that the core hook functions are simplified. This may introduce some challenges.
304304

305-
The central function for cache simulation is get:
305+
The central function for cache simulation is `get` and its common internal logic is:
306306

307307
!!! note
308308
Cache state is updated automatically, since update_cache = true by default.

0 commit comments

Comments
 (0)