Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

Install instructions not easily readable online #71

Open
rlskoeser opened this issue Dec 27, 2016 · 1 comment
Open

Install instructions not easily readable online #71

rlskoeser opened this issue Dec 27, 2016 · 1 comment

Comments

@rlskoeser
Copy link

rlskoeser commented Dec 27, 2016

The installing.html file referenced in the README provides useful installation instructions, but is not easily readable on GitHub. I recommend including it in the GitHub pages site and then linking directly to the current version from the readme. (Alternatively, you could convert the installation instructions to markdown for easy display on GitHub directly.)

Might be nice to link to exist documentation on the package manager, for anyone who needs more info/help on installing package dependencies.

Also consider adding a link to the github pages site more generally.

@rlskoeser
Copy link
Author

rlskoeser commented Dec 27, 2016

Related: installation instructions indicate that the xml data repos include instructions for loading data, but they do not. See Princeton-CDH/bluemountain-transcriptions#19

It looks like there is some documentation of this in the bluemountainsprings readme - probably better to document more thoroughly on the actual data repo and reference the documentation in the readme or (better) installation instructions.

Possibly also relevant (i.e., needs documentation for loading data) on the other data repo? https://github.com/pulibrary/BlueMountain

@rlskoeser rlskoeser changed the title Install instructions not easily readable as html Install instructions not easily readable online Dec 27, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant