From 691710b005d9ecf584811a716c6103fd563f1dd2 Mon Sep 17 00:00:00 2001 From: "Thomas A. Christensen II" <25492070+MillironX@users.noreply.github.com> Date: Sun, 11 Oct 2020 20:48:19 -0600 Subject: [PATCH] Simplify README --- README.md | 153 +++++++++--------------------------------------------- 1 file changed, 25 insertions(+), 128 deletions(-) diff --git a/README.md b/README.md index ad0e397..1840485 100644 --- a/README.md +++ b/README.md @@ -1,146 +1,47 @@ # [:cow:]: beefblup +[![GitHub license](https://img.shields.io/github/license/MillironX/beefblup)](https://github.com/MillironX/beefblup/blob/master/LICENSE.md) +[![Join the chat at https://gitter.im/beefblup/community](https://badges.gitter.im/beefblup/community.svg)](https://gitter.im/beefblup/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +[![Github all releases](https://img.shields.io/github/downloads/MillironX/beefblup/total.svg)](https://GitHub.com/MillironX/beefblup/releases) + beefblup is a program for ranchers to calculate expected breeding values (EBVs) for their own beef cattle. It is intended to be usable by anyone without requiring any prior knowledge of computer programming or linear algebra. Why? It's part of my effort to **\#KeepEPDsReal** -[:arrow_down_small: Download beefblup](https://github.com/MillironX/beefblup/archive/master.zip) +## Installation -> **Notice:** beefblup for MATLAB and beefblup for Python are going away. I'm -> going to make changes here soon that will break the MATLAB version of -> beefblup, and I don't intend to update it anymore. (How many ranchers do you -> know that can afford MATLAB?) As for beefblup for Python, it never really got -> off the ground, and beefblup for Julia has superceded it. +1. [Download and install Julia](https://julialang.org/downloads/platform/) +2. Open a new Julia window and type the `]` key +3. Type `add XLSX Gtk` and press **Enter** -## For Users +Alternatively, you can run the [install +script](https://github.com/MillironX/beefblup/raw/master/Julia/install.jl) from +Julia. -### Installation - -#### Windows (My Platform) - -1. Press the **Windows Key** + **X**, and then press **A**, and select **Yes** -2. [Install Chocolatey](https://chocolatey.org/install) using the PowerShell - window that opened -3. Close PowerShell -4. Press the **Windows Key** + **X**, and then press **A**, and select **Yes** - (Again) -5. Type `choco install Julia -y` into PowerShell and press **Enter** -6. Close PowerShell once Chocolatey has finished -7. [Download beefblup](https://github.com/MillironX/beefblup/archive/master.zip) - and unzip it to somewhere you will remember it -8. Hold down the **Shift** key, and **right-click** in a blank space in the - "Julia" folder of beefblup -9. Click **Open PowerShell window here" -10. Type `julia install.jl` into PowerShell and press **Enter** -11. Close PowerShell once Julia has finished - -Why do you need Chocolatey? Because it allows you to access Julia (and therefore -beefblup) from the **Shift**+**Right-click** menu directly, without having to -worry about `cd` commands or editing your `%PATH%`. That's good, right? - -#### Mac - -1. [Download and install Julia](https://julialang.org/downloads/) -2. Open terminal.app, and run the following - -```bash -curl https://github.com/MillironX/beefblup/archive/master.zip -o beefblup.zip -unzip beefblup.zip -rm beefblup.zip -``` - -3. Quit terminal.app -4. Open julia.app, and run the following - -```julia -cd("~/beefblup/beefblup-master/Julia") -include("install.jl") -``` - -5. Quit julia.app - -I don't know if these are right, since I can't afford a Mac. If any of you -super-privileged Apple snobs out there use beefblup, please add proper -instructions here and submit a pull request. - -#### Debian/Ubuntu Linux - -TODO: Add instructions here. This is slightly complicated since there is no -Julia package in the main repositories, and I don't use Debian distros enough to -know where to find a third-party repos - -#### Fedora Linux (The best platform) - -From a new terminal, run - -```bash -sudo dnf install julia -y -wget https://github.com/MillironX/beefblup/archive/master.zip -O beefblup.zip -unzip beefblup.zip -rm beefblup.zip -cd beefblup/beefblup-master/Julia -julia install.jl -exit -``` - -#### Other Platforms - -Seriously? If you're enough of a geek to be using something else, you can figure -this out on your own. - -### How to Use +## How to Use > **Note:** beefblup and [Juno](https://junolab.org)/[Julia Pro](https://juliacomputing.com/products/juliapro.html) currently [don't get along](https://github.com/JunoLab/Juno.jl/issues/118). > Although it's tempting to just open up beefblup in Juno and press the big play > button, it won't work. Follow these instructions until it's fixed. If you > don't know what Juno is: ignore this message. -#### All platforms - -1. Download the [Excel template](https://github.com/MillironX/beefblup/raw/master/Excel/Master%20BLUP%20Worksheet.xlsx) -2. Replace the sample data in the spreadsheet with your own +1. Download the [beefblup ZIP + file](https://github.com/MillironX/beefblup/archive/0.1.zip) and unzip it + someplace memorable +2. Make a copy of the "Master BLUP Worksheet" and replace the sample data with your own 3. If you wish to add more contemporary group traits to your analysis, replace or add them to the right of the Purple section -4. Save, and continue with your platform-specific instructions below - -#### Windows - -5. Remember where you downloaded beefblup to when you installed it -6. Hold down the **Shift** key, and **right-click** in a blank space in the - "Julia" folder of beefblup -7. Click **Open PowerShell window here" -8. Type `julia beefblup.jl` into PowerShell and press **Enter** -9. Select the spreadsheet you created in Step 4 +4. Save and close +5. In your file explorer, copy the address of the "Julia" folder +6. Launch Julia +7. Type `cd("