소스 검색

Clean up README after mirror issues have been rectified

add-license-1
Trevor Irons 6 년 전
부모
커밋
04018592e0
1개의 변경된 파일17개의 추가작업 그리고 7개의 파일을 삭제
  1. 17
    7
      README.md

+ 17
- 7
README.md 파일 보기

@@ -1,12 +1,22 @@
1
-
2 1
 # Akvo 
3
-Akvo is a surface NMR processing workstation
4
-.hello whirld, still here, yup, 
2
+ Akvo provides processing of surface NMR data. It aims to be simple to use yet flexible for accommodating changes to processing flow. Akvo is written primarily in Python 3 with a small amount of R as well. The application is written around a Qt GUI with plotting provided by Matplotlib.
3
+
4
+The bleeding-edge code may be accesed using the git client 
5
+```
6
+git clone https://git.lemmasoftware.org/akvo.git  
7
+```
8
+or, using our GitHub mirror 
9
+```
10
+git clone https://github.com/LemmaSoftware/akvo.git  
11
+```
5 12
 
6
-Please...work 
7
-* it won't 
8
-* why?
13
+## Installation 
14
+Installation is straightforward. The only prerequisite that is sometimes not properly handled is PyQt5 which needs to be manually installed. 
9 15
 
16
+```
17
+python3 setup.py build 
18
+python3 setup.py install
19
+```
10 20
 
11 21
 ## Team 
12 22
 Akvo is developed by several teams including the University of Utah.
@@ -17,6 +27,6 @@ Akvo currently has preprocessing capabilities for VistaClara GMR data.
17 27
 ## Benefits 
18 28
 Processing steps are retained and logged in the processed file header, which is written in YAML. 
19 29
 This allows data processing to be repeatible, which is a major benefit. 
20
-YAML files are human readible, and easily ediable. Hello. 
30
+
21 31
 ## Languages
22 32
 Akvo is written primarily in Python 3, but has components written in R as well. The graphical user unterface is written in PyQt5.  An interface to modelling software written in C++ is in development. 

Loading…
취소
저장