First commit

Author: rboston628@gmail.com

.gitignore

@@ -1,32 +1,14 @@
-# Prerequisites
-*.d
-
-# Compiled Object files
-*.slo
-*.lo
+.DS_Store
+*.aux
+*.out
+*.toc
+*.log
+*.out
+*.gz
+*.log
 *.o
-*.obj
-
-# Precompiled Headers
-*.gch
-*.pch
-
-# Compiled Dynamic libraries
-*.so
-*.dylib
-*.dll
-
-# Fortran module files
-*.mod
-*.smod
-
-# Compiled Static libraries
-*.lai
-*.la
 *.a
-*.lib
-
-# Executables
-*.exe
-*.out
-*.app
+output/*
+obj/*
+*.tex
+testing/*

README.md

@@ -1,2 +1,23 @@
 # GRPulse
-Newtonian and relativistic asteroseismology code for simple models of white dwarf stars.
+Newtonian and relativistic asteroseismology code for simple models of white dwarf stars
+See documentation for further information
+
+Released under GNU General Public License
+=======
+
+## Overview
+`GRPulse` is a Newtonian and relativistic asteroseismology code for simple models of white dwarf stars.  It is capable of creating the simple models natively, then calculating the normal modes of pulsation in linear theory.  Support is also available for stars calculated with the [`MESA` stellar evolution code](http://mesa.sourceforge.net).   Released under GNU General Public License, and in compliance with open science principles.
+
+## Documentation
+There is extensive [documentation](https://github.com/rboston628/GRPulse/blob/master/documentation/documentation.pdf), explaining in great detail the numerical methods and calculation of the physical properties for each model.
+
+## Citation
+This code was written as part of my dissertation research, and several papers are planned.  
+The first paper, explaining this version of the code, is to be submitted to *Astrophysics Journal*.
+
+If you use this code for your research before official publication, cite tentatively as Boston, Dunlap, and Clemens (2021), or contact me for more complete information.
+
+## Attribution
+If you adapt parts of this code into your own asteroseismology code, include attribution to Reece Boston and cite the above paper within a comment in the source code.
+
+![Alsaac Postnewton](https://avatars.githubusercontent.com/u/52183986?s=400&u=7bbbafdd9277acc2c24fc2494f5df2ac2f472767&v=4)