Documentation

zhujun98 · Sep 20, 2023 · d406ab6 · d406ab6
1 parent 4b60972
commit d406ab6
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,17 @@
 # RECASTX
 
-[![docs](https://github.com/zhujun98/recastx/actions/workflows/docs.yml/badge.svg)](https://github.com/zhujun98/recastx/actions/workflows/docs.yml)
+[![documentation](https://github.com/zhujun98/recastx/actions/workflows/docs.yml/badge.svg)](https://github.com/zhujun98/recastx/actions/workflows/docs.yml)
 
 ---
 
 [comment]: # (Any modification to the following content should also be implemented in 'docs/docs/index.md')
 
+RECASTX is a GPU-accelerated software written in modern C++(17). 
 This project has been developed based on a successful proof-of-principle test [1] 
 using [RECAST3D](https://github.com/cicwi/RECAST3D.git) in 2019 at the 
 [TOMCAT](https://www.psi.ch/en/sls/tomcat), [Swiss Light Source](https://www.psi.ch/en/sls). 
-It aims at providing a near real-time streaming data analysis and visualization 
-tool to allow monitoring [tomoscopy](https://doi.org/10.1002/adma.202104659) 
+It aims at providing a near real-time streaming data processing and visualization 
+tool to allow guide [tomoscopy](https://doi.org/10.1002/adma.202104659) 
 experiments effectively. It also serves as the foundation of building a smart 
 data acquisition system which has the potential to reduce the recorded data size 
 by removing trivial or repetitive data while preserving the important scientific 

diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -3,7 +3,9 @@
 
 [comment]: # (Any modification to the following content should also be implemented in '../../README.md')
 
-RECASTX (**REC**onstruction of **A**rbitrary **S**labs in **T**omography **X**) has been developed based on a successful proof-of-principle test [1]
+RECASTX (**REC**onstruction of **A**rbitrary **S**labs in **T**omography **X**) 
+is a GPU-accelerated software written in modern C++(17).
+This project has been developed based on a successful proof-of-principle test [1]
 using [RECAST3D](https://github.com/cicwi/RECAST3D.git) in 2019 at the
 [TOMCAT](https://www.psi.ch/en/sls/tomcat), [Swiss Light Source](https://www.psi.ch/en/sls).
 It aims at providing a near real-time streaming data analysis and visualization