Skip to content

Commit 4406116

Browse files
committed
Improved README.
1 parent 865f076 commit 4406116

File tree

2 files changed

+17
-69
lines changed

2 files changed

+17
-69
lines changed

README.md

+17-69
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
11
[![Build Status](https://travis-ci.org/FieldDB/dative.svg?branch=master)](https://travis-ci.org/FieldDB/dative)
2-
# Dative: a GUI for FieldDB and the OLD
3-
2+
# Dative
43

54
## Description
65

7-
Dative is a browser-based application for linguistic fieldwork and language
8-
documentation.
6+
Dative is a graphical interface for linguistic fieldwork and language
7+
documentation applications. At present, Dative works with the [Online
8+
Linguistic Database (OLD)](http://www.onlinelinguisticdatabase.org).
9+
910

10-
Its high-level goals are:
11+
## Features
1112

12-
- to interface with multiple server-side backends (FieldDB corpora, OLDs)
13-
- to incorporate the best parts of existing linguistic fieldwork database
14-
application GUIs:
13+
- Collaboration and data sharing
14+
- Advanced and smart search
15+
- Automatic morpheme cross-referencing
16+
- Build morphological parsers and phonologies
17+
- CSV import
18+
- Text creation
19+
- Media file (i.e., audio, video, image)-to-text association.
20+
- User access control
21+
- Documentation
22+
- Open source
1523

16-
- [Spreadsheet](http://app.lingsync.org/)
17-
- [Prototype](https://chrome.google.com/webstore/detail/placeholder/eeipnabdeimobhlkfaiohienhibfcfpa)
18-
- [OLD](http://www.onlinelinguisticdatabase.org)
19-
- [FLEx](http://fieldworks.sil.org/flex/)
20-
- [EOPAS](http://www.eopas.org/)
24+
![Screenshot of Dative](dative-screenshot.png)
2125

22-
![Gratuitous screenshot](dative-screenshot.png)
2326

2427
## For Developers
2528

@@ -105,58 +108,3 @@ The above command generates files in the docs/ directory. Because docco
105108
overwrites files of the same name in different directories, I have configured
106109
the Gruntfile to rename each file for doc generation using the file's path.
107110

108-
109-
110-
#### Compass/Sass Complications
111-
112-
Long story short: we are not currently using Compass/Sass/SCSS.
113-
114-
The default grunt file from the Backbone Yo generator uses the
115-
grunt-contrib-compass Grunt plugin to convert SCSS/Sass files to CSS. This
116-
requires that Ruby, Sass, and Compass >=0.12.2 be installed. If you're on OS X
117-
or Linux you probably already have Ruby installed; test with ruby -v in your
118-
terminal.
119-
120-
I have been unable to successfully install Compass on Debian. Following
121-
http://www.rosehosting.com/blog/install-ruby-sass-and-compass/, I did the
122-
following:
123-
124-
$ sudo apt-get install rubygems
125-
$ sudo gem install compass
126-
127-
I can find compass in /var/lib/gems/1.8/gems/compass-0.12.7/bin/compass; however,
128-
the Grunt tasks are unable to locate it (despite how I alter my $PATH).
129-
130-
On other Unix systems (with Ruby installed), successfully installing Compass
131-
and Sass may be as easy as running:
132-
133-
$ sudo gem update --system && gem install compass
134-
135-
I had no trouble installing Compass/Sass on my Mac OS X system and running the
136-
default Yo Backbone generator's Gruntfile. However, since Debian is not
137-
cooperating with Ruby/Compass, I have (at present) commented out the calls to
138-
the compass Grunt task in the Gruntfile. If we decide that using SCSS is
139-
important at a later time, it may be necessary to delve into this
140-
Debian/Compass issue further.
141-
142-
143-
### Coding Conventions
144-
145-
The [CoffeeScript styleguide](https://github.com/polarmobile/coffeescript-style-guide)
146-
should be followed. Adherence to the second principle of *The Zen of Python* is
147-
advised: "Explicit is better than implicit."
148-
149-
A baseline test for decent CoffeeScript is to run `grunt lint` and ensure that
150-
there are no errors. For now I have configured grunt-coffeelint to allow
151-
implicit parentheses but issue warnings. It may be a good idea to change these
152-
warnings to errors if the code becomes unreadable.
153-
154-
For articles on how CoffeeScript can encourage the creation of unreadable
155-
code, see:
156-
157-
- http://ceronman.com/2012/09/17/coffeescript-less-typing-bad-readability/
158-
- http://ryanflorence.com/2011/case-against-coffeescript/
159-
160-
161-
162-

dative-screenshot.png

172 KB
Loading

0 commit comments

Comments
 (0)