commit - 857b086fcddd4bb1476bc5a5892b27e3bb4ccead
commit + 0e6203d5119bb24089a56e969827fa6bb36b0ee3
blob - /dev/null
blob + 3c83e45515ee3c19240dddb92cfda78e9577a2be (mode 644)
--- /dev/null
+++ README.txt
@@ -0,0 +1,40 @@
+AsteroidPipeline.jl
+
+An open-source Julia pipeline for asteroid search campaigns, developed for
+use with the International Astronomical Search Collaboration (IASC)
+https://iasc.cosmosearch.org/. Detects moving and variable sources across a
+sequence of FITS frames, optionally via ZOGY difference imaging, and
+calibrates and cross-matches the result against known-object catalogs
+(SkyBoT, VSX, SIMBAD).
+
+Full documentation, including project status, real-data validation results,
+known limitations, and the complete API reference, is at
+https://richard7987.github.io/AsteroidPipeline.jl/dev/.
+
+Installation
+------------
+
+   using Pkg
+   Pkg.activate(".")
+   Pkg.instantiate()
+
+A reproducible development environment is also provided via Nix (flake.nix):
+
+   nix develop
+
+Contributing
+------------
+
+docs/make.jl builds the documentation site (Documenter.jl
+https://github.com/JuliaDocs/Documenter.jl + DocumenterVitepress.jl
+https://github.com/LuxDL/DocumenterVitepress.jl); build it locally with:
+
+   julia --project=docs docs/make.jl
+
+.github/workflows/Documenter.yml builds and deploys it to GitHub Pages on
+every push to main.
+
+License
+-------
+
+MIT. See LICENSE.