add first installation instructions

m3g · Sep 4, 2023 · cb53d05 · cb53d05
1 parent 657256b
commit cb53d05
Show file tree

Hide file tree

Showing 2 changed files with 43 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -10,6 +10,29 @@ analysis tools.
 
 It is currently on very early development stage.
 
+## Installation
+
+```julia
+import Pkg; Pkg.add(url="http://github.com/m3g/MolSimToolkit.jl")
+```
+
+## Using
+
+```julia
+using MolSimToolkit
+```
+
+## Recommended
+
+Also install `PDBTools`:
+
+```julia
+import Pkg; Pkg.add("PDBTools")
+import PDBTools
+```
+
+
+
 
 
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,3 +2,23 @@
 
 [MolSimToolkit.jl](https://github.com/m3g/MolSimToolkit.jl) is in very early stages of development.
 
+## Installation
+
+```julia
+import Pkg; Pkg.add(url="http://github.com/m3g/MolSimToolkit.jl")
+```
+
+## Using
+
+```julia
+using MolSimToolkit
+```
+
+## Recommended
+
+Also install `PDBTools`:
+
+```julia
+import Pkg; Pkg.add("PDBTools")
+import PDBTools
+```