From 2dcf5abf30c23118206e65718014932b931b5508 Mon Sep 17 00:00:00 2001 From: Brian Toby Date: Thu, 4 Apr 2024 09:29:49 -0500 Subject: [PATCH] Update README.md expand --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 55c736d..89ae564 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,19 @@ # GSAS-II Web Content ## Description -This repository contains the GSAS-II web content, which includes installation information for users as well as tutorials that demonstrate how different functionality -in GSAS-II works. +This repository contains the GSAS-II web content, which includes installation information for users, as well as tutorials that demonstrate how different functionality in GSAS-II works. ## URLs -* The GSAS-II home page [is here](https://advancedphotonsource.github.io/GSAS-II-tutorials/index.html) +* **Home Page**: The GSAS-II home page [is here](https://advancedphotonsource.github.io/GSAS-II-tutorials/index.html), built from files in this repo. -* The tutorials are usually accessed from the Help->Tutorials -menu in the GSAS-II program (this will ease downloading the files needed to -run the tutorials), but tutorials can also be accessed from this repository via [from this link](https://advancedphotonsource.github.io/GSAS-II-tutorials/tutorials.html) +* **Tutorials**: It is best to access the tutorials from within GSAS-II using the Help->Tutorials menu (this will simplifies downloading the files needed to run the tutorials), but tutorials can also be accessed [from this link](https://advancedphotonsource.github.io/GSAS-II-tutorials/tutorials.html). The tutorials are also found in this repo. -## Repo Contents +* **Help Pages**: There are three HTML web pages used within GSAS-II for context-sensitive help. These files are stored in the [GSAS-II source code repo](https://github.com/AdvancedPhotonSource/GSAS-II), but for convenience, [they can also be accessed here](https://advancedphotonsource.github.io/GSAS-II-tutorials/help/gsasII-index.html). + +## Repo Organization Each tutorial is placed here in its own subdirectory. In that subdirectory, there will be a web page for that tutorial (extension .html or .htm) and two additional subdirectories, one named `data`, with the input file(s) needed for that tutorial and another with a name generated from the web page file name that contains images for the web page. -In addition there are a few special directories: +In addition, there are a few special directories: ### docs The docs directory contains documentation for externally generated codes, such as @@ -22,3 +21,6 @@ DIFFaX, NIST*LATTICE and PDFfit2. ### scripts The scripts directory contains a script (makeGitTutorial.py) used to build the web page referenced above. + +### webdocs +Contains RestructuredText (.rst) files, used to produce the GSAS-II home page, installation instructions and related web content.