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

Commit

Permalink
Update SETUP.md based on OpenCon do-a-thon (#89)
Browse files Browse the repository at this point in the history
* Update SETUP.md based on OpenCon do-a-thon

sparcopen/doathon#21

* git diff --color-words, not --word-diff

* Specify no Windows support in SETUP.md

manubot/rootstock#91

* Doc: conda env installs on macOS

I installed the environment on macOS 10.12.6 on 2017-11-16 and ran
`sh build/build.sh` successfully.
  • Loading branch information
dhimmel authored Nov 16, 2017
1 parent d5693f4 commit a7aaaac
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@
The process to create a new Manubot manuscript is a bit challenging, because it requires a few steps that are difficult to automate.
However, you will only have to perform these steps once for each manuscript.
These steps should be performed in a terminal, starting in the directory where you want the manuscript folder be created.
Setup is supported on Linux and macOS, but [**not on Windows**](https://github.com/greenelab/manubot-rootstock/issues/91).

## Configuration

First, you must configure two environment variables (`OWNER` and `REPO`).
These variables specify the GitHub repository for the manuscript (i.e. `https://github.com/OWNER/REPO`).
**Edit the following commands with your manuscript's information:**

```sh
# GitHub account (change from greenelab)
Expand All @@ -18,6 +20,9 @@ REPO=manubot-rootstock

## Create repository

**Execute the remaining commands verbatim.**
They do not need to be edited (if the setup works as intended).

Next you must clone `greenelab/manubot-rootstock` and configure its branches and remotes:

```sh
Expand Down Expand Up @@ -72,7 +77,7 @@ ssh-keygen \
echo https://github.com/$OWNER/$REPO/settings/keys
```

Manually add `deploy.key.pub` (with write access) to GitHub under the repository's deploy key settings (the URL echoed above).
Manually add the text of `deploy.key.pub` (with write access) to GitHub under the repository's deploy key settings (the URL echoed above).
Give the key a descriptive title, such as "Travis CI Manubot".

For the next step, you need the [Travis command line client](https://github.com/travis-ci/travis.rb) installed.
Expand Down Expand Up @@ -138,7 +143,7 @@ git rm content/02.delete-me.md

## Finalize

Run `git status` or `git diff --word-diff` to check that the following files have unstaged changes:
Run `git status` or `git diff --color-words` to check that the following files have unstaged changes:

+ `README.md`
+ `ci/deploy.key.enc`
Expand Down
2 changes: 1 addition & 1 deletion build/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ conda env create --file environment.yml
```

Activate with `source activate manubot`.
Currently, the environment requires Linux.
The environment should successfully install on both Linux and macOS (and possibly Windows).

0 comments on commit a7aaaac

Please sign in to comment.