Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix/777 #952

Merged
merged 13 commits into from
Apr 16, 2015
Merged

Fix/777 #952

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
2a03f90
@ getting-started.rst : add information for OS X mac port distro user.
Apr 14, 2015
7326f14
Merge branch 'master' of https://github.com/ged-lab/khmer into fix/777
Apr 14, 2015
f5840db
@ ChangeLog : add changelog entry.
Apr 14, 2015
ed45907
@ getting-started.rst : added information for OS X homebrew distro us…
Apr 14, 2015
79cd01c
@ ChangeLog : bugfix spellcheck.
Apr 14, 2015
b5ae3cd
Merge branch 'master' of https://github.com/ged-lab/khmer into fix/777
Apr 14, 2015
e922cd7
@ getting-started.rst : add informaton for Debian and Ubuntu distro.
Apr 14, 2015
27ab342
@ getting-started.rst : add informaton for Debian and Ubuntu distro.
Apr 14, 2015
19bd995
@ ChangeLog : bugfix spelling.
Apr 14, 2015
eb6be71
Merge branch 'master' of https://github.com/ged-lab/khmer into fix/777
Apr 15, 2015
5caf15b
@ getting-started.rst : add copyright header
Apr 16, 2015
a01b805
@ ChangeLog : update changelog.
Apr 16, 2015
069fd41
@ getting-started.rst : bugfix restructuredtext.
Apr 16, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions ChangeLog
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
2015-04-15 Elmar Bucher <buchere@ohsu.edu>

* khmer/doc/dev/getting-started.rst: add information for OS X
mac port and homebrew distro users as well as Linux
Debian and Ubuntu distro users.
And add copyright header.

2015-04-15 Susan Steinman <steinman.tutoring@gmail.com>

* khmer/tests/khmer_tst_utils.py,doc/dev/a-quick-guide-to-testing.rst
Expand Down
33 changes: 33 additions & 0 deletions doc/dev/getting-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
.. This file is part of khmer, http://github.com/ged-lab/khmer/, and is
Copyright (C) Michigan State University, 2009-2015. It is licensed under
the three-clause BSD license; see doc/LICENSE.txt.
Contact: khmer-project@idyll.org


Getting started with khmer development
======================================

Expand Down Expand Up @@ -95,6 +101,15 @@ One-time Preparation
tar xzf virtualenv*
cd virtualenv-*; python2.7 virtualenv.py ../env; cd ..

`Mac ports <https://www.macports.org/>`__ users on the OS X platform can
install pip by execution from the command line::

sudo port install py27-pip

`Homebrew <http://brew.sh/>`__ users on the OS X platform will have pip
already installed


`Conda <https://github.com/conda/conda>`__ users on any platform
should instead create a separate Conda environment::

Expand All @@ -116,6 +131,24 @@ One-time Preparation
source activate khmer
cd khmer
make install-dependencies

#. Cppcheck installation:

`Debian <https://www.debian.org/>`__ and
`Ubuntu <http://www.ubuntu.com/>`__ Linux distro users can
install cppcheck by executing from the command line::

sudo apt-get install cppcheck

`Mac ports <https://www.macports.org/>`__ users on the OS X platform can
install cppcheck by executing from the command line::

sudo port install cppcheck

`Homebrew <http://brew.sh/>`__ users on the OS X platform can
install cppcheck by executing from the command line::

sudo brew install cppcheck
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets include Ubuntu & Debian Linux: sudo apt-get install cppcheck



Building khmer and running the tests
Expand Down