From a997efb387c178e08a65057c1e4c948fdbb6ba58 Mon Sep 17 00:00:00 2001
From: Eddie McWhirter <emcwhirter@usgs.gov>
Date: Mon, 29 Jun 2015 15:57:46 -0600
Subject: [PATCH] More reorganization on Readme.
---
README.md | 10 +++++----
readme_dependency_install.md | 42 +++++++++++++++++++++---------------
2 files changed, 31 insertions(+), 21 deletions(-)
diff --git a/README.md b/README.md
index 1901fdc7..1cd5bd7a 100644
--- a/README.md
+++ b/README.md
@@ -6,18 +6,18 @@ Geomag algorithms includes tools to fetch, process, and output geomag data.
[Documentation](./docs/README.md)
+<a name="install"></a>
Install
-------
-We recommend using [virtual environments][]. Make sure you are in your
-`geomag-algorithms` project directory.
+We recommend using [virtual environments][].
1. Install `python` (2.7.X)
- On OS X, we recommend using Homebrew ( http://brew.sh/ )
- - On Windows, go to the [Windows details](readme_dependency_install.md)
- first
+ - On Windows, go to the Windows heading in the
+ [Install details](readme_dependency_install.md) first
2. Install numpy, obspy requires this be installed separately.
@@ -35,6 +35,7 @@ We recommend using [virtual environments][]. Make sure you are in your
[virtual environments]: http://docs.python-guide.org/en/latest/dev/virtualenvs/
+<a name="develop"></a>
Developing
----------
@@ -57,6 +58,7 @@ Developing
grunt
+<a name="standards"></a>
Coding Standards
----------------
diff --git a/readme_dependency_install.md b/readme_dependency_install.md
index 33b96f75..a551e4d5 100644
--- a/readme_dependency_install.md
+++ b/readme_dependency_install.md
@@ -1,22 +1,6 @@
Readme dependencies
-### Add an SSH Key to GitHub ###
-
- 1. `ssh-keygen -t rsa -b 2048` (in terminal)
- 2. Press **Enter** to accept the default save location.
- 3. Enter a passphrase that you will remember.
- 4. `cat ~/.ssh/id_rsa.pub`
- Copy the text block that is displayed.
- This is your SSH key.
- If you're on Window and can't copy the text from the terminal, go
- to `C:\Users\[your username here]\.ssh` and open the `id_rsa.pub` file
- with notepad.
- 5. In GitHub, click **Edit Your Profile**.
- 6. Select **SSH Keys** on the left.
- 7. Click **Add SSH key**. Give it a meaningful title.
- 8. Copy your SSH Key into the Key, and click **Add key**.
-
----
+<a name="windows"></a>
### Windows ###
1. You will need a terminal tool for Windows. We used [Git Bash][] to test these
@@ -46,6 +30,8 @@ Readme dependencies
If it isn't, update your PATH so that Conda's HOME is before any other
versions of Python.
+1. Head back over to the main [install](README.md#install) and complete the
+ instructions there.
[Git Bash]: http://git-scm.com/download/win
[Cygwin]: http://cygwin.com/install.html
@@ -53,6 +39,7 @@ Readme dependencies
[Anaconda]: http://continuum.io/downloads
---
+<a name="mac"></a>
### Mac ###
1. Install `node`, `git` and `python` (2.7.X).
@@ -77,3 +64,24 @@ Readme dependencies
Make sure to navigate back to your `geomag-algorithms` project directory.
[Homebrew]: http://brew.sh/
+
+---
+<a name="ssh"></a>
+### Add an SSH Key to GitHub ###
+
+This only needs to be completed if you plan on developing and pushing new code
+to this project.
+
+ 1. `ssh-keygen -t rsa -b 2048` (in terminal)
+ 2. Press **Enter** to accept the default save location.
+ 3. Enter a passphrase that you will remember.
+ 4. `cat ~/.ssh/id_rsa.pub`
+ Copy the text block that is displayed.
+ This is your SSH key.
+ If you're on Window and can't copy the text from the terminal, go
+ to `C:\Users\[your username here]\.ssh` and open the `id_rsa.pub` file
+ with notepad.
+ 5. In GitHub, click **Edit Your Profile**.
+ 6. Select **SSH Keys** on the left.
+ 7. Click **Add SSH key**. Give it a meaningful title.
+ 8. Copy your SSH Key into the Key, and click **Add key**.
--
GitLab