GalSim-developers/GalSim — pull request #272 by rmandelb (2012-09-21 13:54:30+00:00)
Title: #247 - updated README

This pull request is for an updated version of the README that appears on the front page of our GalSim repository and also at the front of the doxygen documentation.

The goal of the changes in this pull request was two-fold:
1) To put some additional information that people who look into the repository for the first time will need to get started (with the idea being that the first place people might look when checking out new code is the README file, so it should helpfully point the first-time user to everything they need to get started).

2) To do this without making the file too long, so it can serve as a concise introduction that gives the basics only.

I tried to make the file reasonably decent-looking for the three different ways of viewing it: in markdown mode on GitHub, in the doxygen documentation, and viewing the text file directly. While I was doing this, I also updated some of the links on the wiki (which pointed to the old and now non-existent README and INSTALL, rather than README.md and INSTALL.md).

I wrote the new text as if v0.1 of the code already exists. Since it will hopefully exist on Monday, and since we will likely merge this over the weekend, the span of time in which the file is on master but without a v0.1 tag will hopefully be short!