Skip to content

Home

Jump to bottom
Catharine McGhan edited this page Feb 5, 2017 · 16 revisions

Welcome to the vagrant-rss wiki!

Recommended O/S and programs for editing these files:

It's recommended that, if you want to modify the files in this git repo, that you (1) work under an Ubuntu O/S and (2) consider using one or more of the following tools:

Development tools:

  • git is needed to download the files in this repository at the commandline
  • otherwise, you need to grab the zip file of the repo from the website using your favorite webbrowser
  • e.g., https://github.com/cmcghan/vagrant-rss/archive/master.zip
  • e.g., https://github.com/cmcghan/vagrant-rss/archive/ubuntu-16.04-xenial.zip
  • git-gui is a GUI frontend for git (invoked by "git gui" at the commandline), and should come installed with git
  • git-cola is another GUI frontend for git
  • meld is a graphical user interface to show diff's between files, generally
  • gitg is a GUI interface for git history and diff viewing across all branches
  • giggle is a GUI interface for git history and diff viewing for the current branch
  • geany is a text editor with some extras
  • spyder is a text editor with some extras

Installation command to use at terminal prompt if editing files (under Ubuntu):

sudo apt-get install git git-gui git-cola meld gitg giggle geany spyder

Programs to test usability of files (under Ubuntu):

sudo apt-get install vagrant virtualbox

License modification:

Note that we use the BSD 3-clause license here. This should not be changed.

We have modeled the text for the LICENSE copyright-owner(s)-wording using these two sources as a guideline:

The primary/originating author for this repository is Catharine L. R. McGhan (github handle: cmcghan), and this was first written in 2016 as part of her work on the Resilient Space Systems project at the California Institute of Technology (Caltech). She has later updated and extended it during her work at the University of Cincinnati (UC). This is why both institutions are listed as main copyright holders.

If you contribute to this repository and work at either of these institutions, or on a project funded by either of these institutions, then you are "covered" already under the copyright heading. It is recommended that, at minimum, you add your name to the AUTHORS file listing, in order to receive due credit for your work :)

If you work at another institution or company, or are helping in your own unfunded time off-the-clock, then you should be covered under the "Additional copyright may be held by others, as reflected in the commit history." line. Please add your name to the AUTHORS file listing. If you become a major contributor, then please do add your institution to the list at the top of the LICENSE file!

Rather than reproducing the full LICENSE file every time at the top of each file, a minimal license heading can instead be included at the top of each (new or modified) file in the repository, referring back to the main LICENSE file.

e.g.:

# Copyright by California Institute of Technology
# All rights reserved. See LICENSE file at:
# https://github.com/cmcghan/vagrant-rss

or:

# Copyright by University of Cincinnati
# All rights reserved. See LICENSE file at:
# https://github.com/cmcghan/vagrant-rss

or:

# Copyright by California Institute of Technology, University of Cincinnati
# All rights reserved. See LICENSE file at:
# https://github.com/cmcghan/vagrant-rss

or:

# Copyright by California Institute of Technology, University of Cincinnati, <your institution here>
# All rights reserved. See LICENSE file at:
# https://github.com/cmcghan/vagrant-rss

or:

# Copyright by <your institution here>
# All rights reserved. See LICENSE file at:
# https://github.com/cmcghan/vagrant-rss

Contact:

If you have questions about this repository or documentation, or would otherwise like to contact the primary author (Cat McGhan), please do so at cat.mcghan@uc.edu! :)

Clone this wiki locally