ICODE-ADC/lammps
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update install section

Browse Source
This commit is contained in:
Richard Berger
2024-08-14 00:03:10 -06:00
parent aa0b6c47c2
commit cf0bc0e6bb
3 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/src/Install_git.rst
View File

@ -60,7 +60,7 @@ between them at any time using "git checkout <branch name>".)
files (mostly by accident). If you do not need access to the entire files (mostly by accident). If you do not need access to the entire
commit history (most people don't), you can speed up the "cloning" commit history (most people don't), you can speed up the "cloning"
process and reduce local disk space requirements by using the process and reduce local disk space requirements by using the
*--depth* git command line flag. That will create a "shallow clone" ``--depth`` git command line flag. That will create a "shallow clone"
of the repository, which contains only a subset of the git history. of the repository, which contains only a subset of the git history.
Using a depth of 1000 is usually sufficient to include the head Using a depth of 1000 is usually sufficient to include the head
commits of the *develop*, the *release*, and the *maintenance* commits of the *develop*, the *release*, and the *maintenance*
@ -122,7 +122,7 @@ changed. How to do this depends on the build system you are using.
.. code-block:: bash .. code-block:: bash
cmake . --build cmake --build .
CMake should auto-detect whether it needs to re-run the CMake CMake should auto-detect whether it needs to re-run the CMake
configuration step and otherwise redo the build for all files configuration step and otherwise redo the build for all files

2
doc/src/Install_tarball.rst
View File

@ -31,7 +31,7 @@ command:
tar -xzvf lammps*.tar.gz tar -xzvf lammps*.tar.gz
This will create a LAMMPS directory with the version date in its name, This will create a LAMMPS directory with the version date in its name,
e.g. lammps-28Mar23. e.g. ``lammps-28Mar23``.
---------- ----------

2
doc/src/Install_windows.rst
View File

@ -34,7 +34,7 @@ When you download the installer package, you run it on your Windows
machine. It will then prompt you with a dialog, where you can choose machine. It will then prompt you with a dialog, where you can choose
the installation directory, unpack and copy several executables, the installation directory, unpack and copy several executables,
potential files, documentation PDFs, selected example files, etc. It potential files, documentation PDFs, selected example files, etc. It
will then update a few system settings (e.g. PATH, LAMMPS_POTENTIALS) will then update a few system settings (e.g. ``PATH``, ``LAMMPS_POTENTIALS``)
and add an entry into the Start Menu (with references to the and add an entry into the Start Menu (with references to the
documentation, LAMMPS homepage and more). From that menu, there is documentation, LAMMPS homepage and more). From that menu, there is
also a link to an uninstaller that removes the files and undoes the also a link to an uninstaller that removes the files and undoes the