Skip to content

Commit 36202be

Browse files
committed
docs: optimize the README.
1 parent d67658a commit 36202be

File tree

1 file changed

+20
-10
lines changed

1 file changed

+20
-10
lines changed

README.md

Lines changed: 20 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,30 +18,32 @@
1818
---
1919

2020

21-
2221
<details>
2322
<summary>Table of Contents</summary>
2423
<ul>
2524
<li><a href="#Documentation">Documentation</a></li>
2625
<li><a href="#Console Demo">Console Demo</a></li>
27-
<li><a href="#Toolkits & Examples">Toolkits & Examples</a></li>
26+
<li><a href="#Integrations & Examples">Integrations & Examples</a></li>
2827
<li><a href="#Get started">Get started</a></li>
2928
<li><a href="#FAQ">FAQ</a></li>
3029
<li><a href="#Contributing">Contributing</a></li>
3130
<li><a href="#Join the community">Join the community</a></li>
31+
<li><a href="#Star history">Star history</a></li>
32+
<li><a href="#Contributor wall of fame">Contributor wall of fame</a></li>
3233
<li><a href="#Map of LLamaSharp and llama.cpp versions">Map of LLamaSharp and llama.cpp versions</a></li>
3334
</ul>
3435
</details>
3536

36-
## Documentation
37+
## 📖Documentation
3738

38-
- [Quick start](https://scisharp.github.io/LLamaSharp/latest/GetStarted/)
39-
- [Tricks for FAQ](https://scisharp.github.io/LLamaSharp/latest/Tricks/)
39+
- [Quick start](https://scisharp.github.io/LLamaSharp/latest/QuickStart/)
40+
- [FAQ](https://scisharp.github.io/LLamaSharp/latest/FAQ/)
41+
- [Tutorial](https://scisharp.github.io/LLamaSharp/latest/Tutorial/)
4042
- [Full documentation](https://scisharp.github.io/LLamaSharp/latest/)
4143
- [API reference](https://scisharp.github.io/LLamaSharp/latest/xmldocs/)
4244

4345

44-
## Console Demo
46+
## 📌Console Demo
4547

4648
<table class="center">
4749
<tr style="line-height: 0">
@@ -55,7 +57,7 @@
5557
</table>
5658

5759

58-
## Toolkits & Examples
60+
## 🔗Integrations & Examples
5961

6062
There are integarions for the following libraries, making it easier to develop your APP. Integrations for semantic-kernel and kernel-memory are developed in LLamaSharp repository, while others are developed in their own repositories.
6163

@@ -76,7 +78,7 @@ The following examples show how to build APPs with LLamaSharp.
7678
![LLamaShrp-Integrations](./Assets/LLamaSharp-Integrations.png)
7779

7880

79-
## Get started
81+
## 🚀Get started
8082

8183
### Installation
8284

@@ -168,7 +170,7 @@ while (userInput != "exit")
168170
For more examples, please refer to [LLamaSharp.Examples](./LLama.Examples).
169171

170172

171-
## FAQ
173+
## 💡FAQ
172174

173175
#### Why GPU is not used when I have installed CUDA
174176

@@ -197,7 +199,7 @@ Generally, there are two possible cases for this problem:
197199
Please set anti-prompt or max-length when executing the inference.
198200

199201

200-
## Contributing
202+
## 🙌Contributing
201203

202204
Any contribution is welcomed! There's a TODO list in [LLamaSharp Dev Project](https://github.com/orgs/SciSharp/projects/5) and you could pick an interesting one to start. Please read the [contributing guide](./CONTRIBUTING.md) for more information.
203205

@@ -215,6 +217,14 @@ Join our chat on [Discord](https://discord.gg/7wNVU65ZDY) (please contact Rinne
215217

216218
Join [QQ group](http://qm.qq.com/cgi-bin/qm/qr?_wv=1027&k=sN9VVMwbWjs5L0ATpizKKxOcZdEPMrp8&authKey=RLDw41bLTrEyEgZZi%2FzT4pYk%2BwmEFgFcrhs8ZbkiVY7a4JFckzJefaYNW6Lk4yPX&noverify=0&group_code=985366726)
217219

220+
## Star history
221+
222+
[![Star History Chart](https://api.star-history.com/svg?repos=SciSharp/LLamaSharp)](https://star-history.com/#SciSharp/LLamaSharp&Date)
223+
224+
## Contributor wall of fame
225+
226+
[![LLamaSharp Contributors](https://contrib.rocks/image?repo=SciSharp/LLamaSharp)](https://github.com/SciSharp/LLamaSharp/graphs/contributors)
227+
218228
## Map of LLamaSharp and llama.cpp versions
219229
If you want to compile llama.cpp yourself you **must** use the exact commit ID listed for each version.
220230

0 commit comments

Comments
 (0)