Skip to content

Commit ddac99d

Browse files
authored
Update README.md
start to phase out refs to old docs & expand internal links
1 parent e2fc1d5 commit ddac99d

File tree

1 file changed

+15
-20
lines changed

1 file changed

+15
-20
lines changed

README.md

Lines changed: 15 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
# GSAS-II
2-
3-
<!-- commented out for now
4-
5-
[![Actions Status][actions-badge]][actions-link]
62
[![Documentation Status][rtd-badge]][rtd-link]
3+
[![Actions Status][actions-badge]][actions-link]
74

5+
<!-- commented out for now
86
[![PyPI version][pypi-version]][pypi-link]
97
[![Conda-Forge][conda-badge]][conda-link]
108
[![PyPI platforms][pypi-platforms]][pypi-link]
11-
129
[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
1310
--!>
1411

@@ -39,22 +36,20 @@ GSAS-II is free open source software.
3936

4037
## URLs
4138
* The
42-
[home page for GSAS-II](https://advancedphotonsource.github.io/GSAS-II-tutorials)
43-
has recently been moved to GitHub, but some content may still be
44-
only at
45-
[the old location](https://subversion.xray.aps.anl.gov/trac/pyGSAS).
46-
Note the new [installation instructions](https://advancedphotonsource.github.io/GSAS-II-tutorials/install.html).
39+
[home page for GSAS-II](https://advancedphotonsource.github.io/GSAS-II-tutorials) has
40+
[installation instructions](https://advancedphotonsource.github.io/GSAS-II-tutorials/install.html) and a link
41+
to [the downloads location](https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/latest).
42+
(There might be some content only at
43+
[the home page](https://subversion.xray.aps.anl.gov/trac/pyGSAS), but I hope not.)
4744

48-
* This repo is the main repository for the GSAS-II source code, but
49-
note that there is a separate repo for the
50-
[GSAS-II installation tools](https://github.com/AdvancedPhotonSource/GSAS-II-buildtools)
51-
and another for
52-
[GSAS-II web content](https://github.com/AdvancedPhotonSource/GSAS-II-tutorials) (including tutorials). The
45+
* [This repo](https://github.com/AdvancedPhotonSource/GSAS-II) is the main repository for the GSAS-II source code (replacing the
5346
[old subversion site](https://subversion.xray.aps.anl.gov/pyGSAS)
54-
and its
55-
[associated web site](https://subversion.xray.aps.anl.gov/trac/pyGSAS/browser)
56-
will be maintained for the immediate future.
57-
* Code documentation: https://gsas-ii.readthedocs.io.
47+
and the [trac web site](https://subversion.xray.aps.anl.gov/trac/pyGSAS/browser)), but there are two additional repo's associated with GSAS-II
48+
* [GSAS-II installation tools](https://github.com/AdvancedPhotonSource/GSAS-II-buildtools) that includes [downloads](https://github.com/AdvancedPhotonSource/GSAS-II-buildtools/releases/latest) as well as [automated build/test scripts](https://github.com/AdvancedPhotonSource/GSAS-II/actions)
49+
and
50+
* [GSAS-II web content](https://github.com/AdvancedPhotonSource/GSAS-II-tutorials) that includes [tutorials](https://advancedphotonsource.github.io/GSAS-II-tutorials/tutorials.html).
51+
52+
* Code documentation: https://gsas-ii.readthedocs.io and scripting documentation: https://gsas-ii-scripting.readthedocs.io (subset of full documentation)
5853

5954
## Please Cite
6055
If you use GSAS-II in any part of your project, please cite it in your
@@ -113,7 +108,7 @@ single refinement with subsequent parametric fitting.
113108

114109
GSAS-II is freely distributed as open source software; see the license file for
115110
more details. GSAS-II runs on Windows,
116-
MacOS, Linux and Raspberry Pi computers. It currently receives >600
111+
MacOS, Linux and Raspberry Pi computers. It currently receives >950
117112
citations/year.
118113

119114
<!-- commented out for now

0 commit comments

Comments
 (0)