EMSE6992_Assignments/Portfolio_Setup.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Portfolios and Setup\n",
    "\n",
    "Below are instructions on how to install, edit, and create a Portfolio. The portfolio template that you will be downloading is a template that I created and which was donated to us by Karl Broman.  All of the pages are in markdown which is really similar to html so editing the files is trivial.\n",
    "\n",
    "In order to receive full credit for assignments and final project, you must install the template, personalize the protfolio (entering in your bio/CV/publications/etc.) and send me the link to the newly created portfolio (username.github.io). Not looking for anything perfect here, just want to see your portfolio successfully hosted on Github and want you to show progress towards getting the portfolio to a point that will enable you to build upon in the future.\n",
    "\n",
    "Download portfolio template from Github (save to your desktop)\n",
    "https://github.com/bsharve/bsharve.github.io\n",
    "\n",
    "Create a github account\n",
    "https://github.com/\n",
    "\n",
    "Within GitHub...Create a repository with your username in the within the name of the repository for example: \"username.github.io\" \n",
    "\n",
    "Upload bsharve.github.io zip file to the new username.github.io repository\n",
    "\n",
    "Download and Install Anaconda\n",
    "https://www.anaconda.com/download/\n",
    "\n",
    "Download and Install Github Desktop \n",
    "https://desktop.github.com/\n",
    "\n",
    "Download and Install Atom IDE\n",
    "https://atom.io/\n",
    "\n",
    "Go to https://username.github.io/ to check and see if the github installation worked correctly\n",
    "\n",
    "There are two ways to edit the portfolios:\n",
    " - Directly within github\n",
    " - Using Github Desktop\n",
    " \n",
    "To edit the portfolio directly within github, go to your https://github.com/username/username.github.io and click directly on the files that you would like to edit.\n",
    "\n",
    "To edit the portolio using Github Desktop, once you have downloaded and installed Github Desktop, go to the file menu and select \"clone repository.\"   This will enable you to clone the Github repository \"username/username.github.io\" to your local computer (make sure to keep track of what directory you cloned the repository to). \n",
    "\n",
    "After you clone the repository you can either use the Atome IDE or any other IDE to edit the files. \n",
    "\n",
    "Within Atom, after you edit a file in the cloned repository, the Github IDE automatically tracks changes that are made. Once changes to the local repository are made, you must push those changes to the repository hosted on Github.  \n",
    "\n",
    "In order to do this, after you edit a file, go back to the Github Desktop and on the left had side of the application you should see \"changed files.\"  This is where the Github Desktop application has been tracking changes made to the local repository.  \n",
    "\n",
    "The next step after changes have been made is to push them to the repository hosted on Github. To do this, you must add a description of the edits to the \"Summary\" text box located on the left lower side of the Github Desktop application and the press the \"Commit to Master\" button on the lower left hand side of the Github Desktop application.\n",
    "\n",
    "After you push the \"Commit to Master\" button, you will now have to push the \"Push Origin\" button on the top right hand side of Github Desktop.\n",
    "\n",
    "This will successfully enable you to update the files from your local repository to the hosted repository on Github.\n",
    "\n",
    "You can also edit and conduct version control directly from the command line.  You will have to install Git from the command line and use the following useful github command line comands:\n",
    "\n",
    "git init git branch -m master gh-pages git add --all git status git commit -m \"first commit\" git remote add origin https://github.com/bsharve/bsharve.github.io.git //git remote remove origin git push -u origin gh-pages\n",
    "\n",
    "The files/folders that you should be looking to edit within your portfolios are as follows:\n",
    "   \n",
    "   .ipynb_checkpoints \t\n",
    "\tAssignments \t\n",
    "\t_includes - /_includes/themes/twitter/ is a directory that has pages that you will need to edit to personalize the portfolio\t\n",
    "\t_layouts \t\n",
    "\t_plugins \n",
    "    assets - this is the directory that contains files and images that you will need to link to.\n",
    "\tdatacarp \t\n",
    "\tpages - folder that has all of the pages that you will need to edit to personalize the portfolio. \t\n",
    "\tstylesheets \t\n",
    "\t.DS_Store \t\n",
    "\t.vimrc \t\n",
    "\t404.md \t\n",
    "\tGemfile \t\n",
    "\tLicense.md \t\n",
    "\tREADME.md \t\n",
    "\tRakefile \t\n",
    "\t_config.yml - This is a file that you will need to edit in order to personalize the portfolio\t\n",
    "\tcrayons.js \t\n",
    "\tfavicon1.ico \t\n",
    "\tindex.md  - This is a file that you will need to edit in order to personalize the portfolio\n",
    "    keybase.txt\n",
    "\tmorefigs.md \t\n",
    "\twesanderson.css \t\n",
    "\twesanderson.js\n"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}