Skip to content

Commit

Permalink
DOC: README.md -- unify tree structure a bit and indentation in some …
Browse files Browse the repository at this point in the history
…blocks
  • Loading branch information
yarikoptic committed Apr 19, 2016
1 parent e4fab92 commit 9308728
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,28 +19,28 @@ share it with others, test it, document it, and track its evolution.

The project has the following structure:

shablona -
|- `README.md`
|- shablona
|- `__init__.py`
|- `shablona.py`
|- data
|- ...
|- tests
|- ...
|- doc
|- `Makefile`
|- `conf.py`
|- sphinxext
|- ...
|- _static
|- ...
|- `setup.py`
|- `.travis.yml`
|- `appveyor.yml`
|- `LICENSE`
|- ipynb
|- ...
shablona/
|- README.md
|- shablona/
|- __init__.py
|- shablona.py
|- data/
|- ...
|- tests/
|- ...
|- doc/
|- Makefile
|- conf.py
|- sphinxext/
|- ...
|- _static/
|- ...
|- setup.py
|- .travis.yml
|- appveyor.yml
|- LICENSE
|- ipynb/
|- ...


In the following sections we will examine these elements one by one. First,
Expand Down Expand Up @@ -84,8 +84,8 @@ In this case, the project data is rather small, and recorded in csv files. Thus,
Either way, you can create a `shablona/data` folder in which you can organize the data. As you can see in the test scripts, and in the analysis scripts, this provides a standard file-system location for the data at:

import os.path as op
import shablona as sb
data_path = op.join(sb.__path__[0], 'data')
import shablona as sb
data_path = op.join(sb.__path__[0], 'data')


### Testing
Expand Down Expand Up @@ -335,7 +335,7 @@ To use this repository as a template, start by cloning it to your own computer u

To point to your own repository on github you will have to issue something like the following:

git remote rm origin
git remote rm origin
git remote add origin https://github.com/arokem/smallish

(replace `arokem` with your own Github user name).
Expand Down

0 comments on commit 9308728

Please sign in to comment.