Skip to content

Commit 8b5eec6

Browse files
authored
Update README.md
1 parent f3ced70 commit 8b5eec6

1 file changed

Lines changed: 27 additions & 10 deletions

File tree

README.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ A fast and scalable CUDA implementation to conduct highly parallelized evolution
88

99
### Contents
1010

11-
- 1️⃣[Description](#description)
12-
- 2️⃣[News](#news)
13-
- 3️⃣[Prerequisites](#prerequisites)
14-
- 4️⃣[Installation Guide](#how-to-install)
15-
- 5️⃣[Running CATE](#how-to-run)
16-
- 6️⃣[Documentation & Help](https://github.com/theLongLab/CATE/wiki)
17-
- 7️⃣[How to Cite](#how-to-cite)
18-
- 8️⃣[Contact](#contact)
19-
- 9️⃣[License](#software-license)
11+
1️⃣ [Description](#description)
12+
2️⃣ [News](#news)
13+
3️⃣ [Prerequisites](#prerequisites)
14+
4️⃣ [Installation Guide](#how-to-install)
15+
5️⃣ [Running CATE](#how-to-run)
16+
6️⃣ [Documentation & Help](https://github.com/theLongLab/CATE/wiki)
17+
7️⃣ [How to Cite](#how-to-cite)
18+
8️⃣ [Contact](#contact)
19+
9️⃣ [License](#software-license)
2020

2121
---
2222

@@ -27,6 +27,8 @@ The CATE software is a CUDA-based solution to enable rapid processing of large-s
2727
🔵 **Here we have provided only a brief overview of CATE's usability.**
2828
🟢 **Please refer to [CATE's wiki](https://github.com/theLongLab/CATE/wiki) to obtain a more detailed understanding of its functionality and usability.**
2929

30+
[_Return to contents_](#contents)
31+
3032
---
3133

3234
#### News
@@ -42,6 +44,8 @@ Apollo also comes with a video tutorial. You can either download and watch it us
4244

4345
[Apollo's preprint is now available on bioRxiv](https://doi.org/10.1101/2024.10.07.617101).
4446

47+
[_Return to contents_](#contents)
48+
4549
---
4650
#### Prerequisites
4751

@@ -50,6 +54,8 @@ Apollo also comes with a video tutorial. You can either download and watch it us
5054
3. NVIDIA's CUDA toolkit (nvcc compiler)
5155
4. C++ compiler (gcc compiler)
5256

57+
[_Return to contents_](#contents)
58+
5359
---
5460

5561
#### How to INSTALL
@@ -102,6 +108,9 @@ To ensure successful installation try running the following:
102108
````
103109
CATE -h
104110
````
111+
112+
[_Return to contents_](#contents)
113+
105114
---
106115

107116
#### How to RUN
@@ -149,6 +158,8 @@ The __HELP__ menu will list all available functions and how each function can be
149158

150159
> ./Test_Main -h
151160
161+
[_Return to contents_](#contents)
162+
152163
---
153164
#### How to Cite
154165

@@ -179,6 +190,8 @@ To cite CATE's code with Apollo's integration please cite the Zenodo release:
179190

180191
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.15299962.svg)](https://doi.org/10.5281/zenodo.15299962)
181192

193+
[_Return to contents_](#contents)
194+
182195
---
183196
#### Contact
184197

@@ -190,14 +203,16 @@ Dr. **Quan** Long (quan.long@ucalgary.ca)
190203

191204
Dr. **Christian** D. Huber (cdh5313@psu.edu)
192205

193-
2. For **Apollo** please address your correspondence to:
206+
2. For **Apollo**, please address your correspondence to:
194207

195208
Dr. **Deshan** Perera (duwagedahampriyabala@ucalgary.ca)
196209

197210
Dr. **Quan** Long (quan.long@ucalgary.ca)
198211

199212
Dr. **Alexander** Platt (alexander.platt@pennmedicine.upenn.edu)
200213

214+
[_Return to contents_](#contents)
215+
201216
---
202217
#### Software License
203218

@@ -223,4 +238,6 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
223238
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
224239
SOFTWARE.
225240

241+
[_Return to contents_](#contents)
242+
226243
---

0 commit comments

Comments
 (0)