readme docstring and manifest in gitignore

anandijain · anandijain · commit 7f4d9c01cd56 · 2021-03-18T20:43:12.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
+Manifest.toml
diff --git a/Project.toml b/Project.toml
@@ -6,6 +6,7 @@ version = "1.6.0"
 [deps]
 DiffEqBase = "2b5f629d-d688-5b77-993f-72d75c75574e"
 DiffEqCallbacks = "459566f4-90b8-5000-8ac3-15dfb0a30def"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
 FileIO = "5789e2e9-d7fb-5bc7-8068-2c6fae9b9549"
 LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
 OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
diff --git a/src/NBodySimulator.jl b/src/NBodySimulator.jl
@@ -1,7 +1,10 @@
 __precompile__()
-
+"""
+$(DocStringExtensions.README)
+"""
 module NBodySimulator
 
+using DocStringExtensions
 using Reexport
 @reexport using DiffEqBase, OrdinaryDiffEq, RecursiveArrayTools
 using StaticArrays, RecipesBase, FileIO
