1. The Enzo Project
  2. Untitled project
  3. enzo-dev
  4. Pull requests

Pull requests

#141 Merged at 19df73c
Repository
chummels
Branch
week-of-code
Repository
enzo
Branch
week-of-code

Update of documentation

Author
  1. chummels
Reviewers
Description

In showing a new user how to install enzo earlier this week, I noticed a number of errors in the installer documentation. One, we're still referencing that the main site for getting the code is googlecode, which is outdated. While updating this, I made sure that it had all of the instructions for getting the code and building it from scratch from current sources (enzo-project.org and bitbucket).

I also got rid of the Doxygen config file and a bunch of old makefile examples which don't get used anymore. I'm open to changing things, but I want to make sure we don't turn away new users with making our installation instructions difficult or outdated.

UPDATE1: Made modifications to account for the suggestions Matt Turk . In addition, updated the current machine list, the current contents of the enzo/src dir, the current show-config defaults, etc. Just generally made things more consistent and hand-holdy for the new user.

Comments (4)

  1. Matt Turk

    These look mostly good to me initially, but I'm going to review this tomorrow. A few immediate comments come to mind. 1) I support removing the old makefiles. 2) They were put there because there was some previous resistance to removing them. 3) Doxygen I'm -0 on removing, since I think in the past it has produced useful things like callgraphs. Thanks for this work, Cameron!

  2. Matt Turk

    Okay, even though I'm -0 on removing Doxygen, it's still in the history so we could get it back eventually, and it's not used now. So I'm okay with that. But there is that one paragraph which I think is benign and helpful, so I would ask it come back in unless you have strong objections.