add readme

CLASS-SZ · Sep 29, 2024 · e84e48a · e84e48a
1 parent 5b64e58
commit e84e48a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/docs/README.md b/docs/README.md
@@ -1 +1,9 @@
 Cosmic Linear Anisotropy Solving System with Machine Learning Accelerated CMB, LSS and Halo Model Observables Computations
+
+To install:
+
+```
+pip install classy_sz
+```
+
+should work on most platforms.
diff --git a/docs/index.rst b/docs/index.rst
@@ -35,7 +35,7 @@ Cosmic Linear Anisotropy Solving System with Machine Learning Accelerated CMB, L
    :maxdepth: 2
    :caption: Installation
 
-   # check here for example of clickable platforms: https://github.com/pypa/cibuildwheel/blob/main/docs/options.md
+   # # check here for example of clickable platforms: https://github.com/pypa/cibuildwheel/blob/main/docs/options.md
 
    notebooks/classy_szfast_install