Improve our README to make it easier for new users (#49711)
This commit is contained in:
parent
4a7508c9df
commit
4b2a96fe06
34
README.md
34
README.md
@ -46,18 +46,42 @@ See the
|
|||||||
[Feature Overview](https://spack.readthedocs.io/en/latest/features.html)
|
[Feature Overview](https://spack.readthedocs.io/en/latest/features.html)
|
||||||
for examples and highlights.
|
for examples and highlights.
|
||||||
|
|
||||||
To install spack and your first package, make sure you have Python & Git.
|
Installation
|
||||||
|
----------------
|
||||||
|
|
||||||
|
To install spack, first make sure you have Python & Git.
|
||||||
Then:
|
Then:
|
||||||
|
|
||||||
$ git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git
|
```bash
|
||||||
$ cd spack/bin
|
git clone -c feature.manyFiles=true --depth=2 https://github.com/spack/spack.git
|
||||||
$ ./spack install zlib
|
```
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>What are <code>manyFiles=true</code> and <code>--depth=2</code>?</summary>
|
||||||
|
<br>
|
||||||
|
|
||||||
> [!TIP]
|
|
||||||
> `-c feature.manyFiles=true` improves git's performance on repositories with 1,000+ files.
|
> `-c feature.manyFiles=true` improves git's performance on repositories with 1,000+ files.
|
||||||
>
|
>
|
||||||
> `--depth=2` prunes the git history to reduce the size of the Spack installation.
|
> `--depth=2` prunes the git history to reduce the size of the Spack installation.
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# For bash/zsh/sh
|
||||||
|
. spack/share/spack/setup-env.sh
|
||||||
|
|
||||||
|
# For tcsh/csh
|
||||||
|
source spack/share/spack/setup-env.csh
|
||||||
|
|
||||||
|
# For fish
|
||||||
|
. spack/share/spack/setup-env.fish
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Now you're ready to install a package!
|
||||||
|
spack install zlib-ng
|
||||||
|
```
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
----------------
|
----------------
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user