search

lanl / LaGriT

Los Alamos Grid Toolbox (LaGriT) is a library of user callable tools that provide mesh generation, mesh optimization and dynamic mesh maintenance in two and three dimensions.
https://lanl.github.io/LaGriT/
Other
116 stars 48 forks source link

documentation for install #238

Open millerta opened 2 years ago

millerta commented 2 years ago

The build and install instructions in documentation are all out of date. See https://github.com/lanl/LaGriT/blob/master/documentation/INSTALL.md

Need to update install and related files to the new scripts as described in the README.md file.

millerta commented 11 months ago

Docs build.md updated text and add links to current instructions at README.md and cmake/README.md

Once mac is confirmed as working for V3.3.3, will finish updates to INSTALL.md

millerta commented 11 months ago

install/build instructions are located in various places, mostly old instructions.

How to combine and update install/build instructions?

README.md = current and simple install/build with links to further instructions.

cmake/README.md = advanced install/build instructions should be replace build.md? change this file to very terse explanation with link to build.md

build.md = from manual, very general and original build instructions - save as old, replace with cmake. documentation/INSTALL.md = install/build instructions V3.32 and older - remove, put into old build page. documentation/DEPENDENCIES.md = old instructions for hdf5, zlib, exodus plus CYGWIN for windows - replace with terse explanation and point to new and old build instructions.

millerta commented 11 months ago

Related to the updates to the build pages, update V3.3.3 release notes to include current build and c-fortran code additions. pages/release_notes/lagrit_release_notes_V3.330.html

There should be a brief description of c-cpp-fortran code guidelines in build

millerta commented 5 months ago

Consider removing /documentation from the repo. Most the files in that directory were carried over from old version control and the old web pages. I updated the pages to label as old, and point to newer instructions. But would be nice to consolidate and remove for a smaller more relevant repo. Need to figure out exactly which pages are being used in current github io.