Skip to content

Commit a772b64

Browse files
committed
Wrap lines & consistently space README and LICENSE
1 parent 9d49c3c commit a772b64

File tree

2 files changed

+54
-16
lines changed

2 files changed

+54
-16
lines changed

LICENSE.md

+24-6
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,36 @@
22

33
Copyright (c) 2016 Alex Gil.
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
6+
associated documentation files (the "Software"), to deal in the Software without restriction,
7+
including without limitation the rights to use, copy, modify, merge, publish, distribute,
8+
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
9+
furnished to do so, subject to the following conditions:
610

7-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
11+
The above copyright notice and this permission notice shall be included in all copies or substantial
12+
portions of the Software.
813

9-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
15+
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
17+
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
18+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
1019

1120
*This project incorporates code covered by the following terms:*
1221

1322
Copyright (c) 2014 Mark Otto.
1423

15-
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
24+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
25+
associated documentation files (the "Software"), to deal in the Software without restriction,
26+
including without limitation the rights to use, copy, modify, merge, publish, distribute,
27+
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
28+
furnished to do so, subject to the following conditions:
1629

17-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
30+
The above copyright notice and this permission notice shall be included in all copies or substantial
31+
portions of the Software.
1832

19-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
34+
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
35+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES
36+
OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
37+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

+30-10
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,38 @@
22

33
[![Build Status](https://travis-ci.org/minicomp/ed.svg?branch=master)](https://travis-ci.org/minicomp/ed) [![Gem Version](https://badge.fury.io/rb/ed..svg)](https://badge.fury.io/rb/ed.)
44

5-
65
![Sample Ed screenshot](https://github.com/minicomp/ed/blob/master/assets/screenshot-home.png)
76

87

9-
108
## Introduction
119

12-
Ed is a [Jekyll](https://jekyllrb.com/) theme designed for textual editors based on [minimal computing](http://go-dh.github.io/mincomp/) principles, and focused on legibility, durability, ease and flexibility.
13-
14-
15-
One of our most pressing and ever revolving needs as scholars is to pass on our textual artifacts from one generation to another. The art of textual editing, among other practices, has helped many cultures to remember and interpret for centuries. Alas, that art is practiced and encouraged in its highest form by a dwindling number of scholars. In a digital environment the problem is compounded by the difficulties of the medium. While vast repositories, and "e-publications" appear on the online scene yearly, very few manifest a textual scholar's disciplined attention to detail. In contrast, most textual scholars who have made the leap to a rigorous digital practice have focused on markup, relying on technical teams to deploy and maintain their work. This makes your average scholarly digital edition a very costly, and therefore limited affair.
16-
17-
As we see it, a minimal edition is one that aims to reduce the size and complexity of the back and front end, and the learning curves for the user and the producer. Out of-the-box, this theme can help you build a simple reading edition, or a traditional scholarly edition with footnotes and a bibliography without breaking the bank. In our estimate, these are the two most immediately useful type of editions for editors and readers. An edition produced with Ed consists of static pages whose rate of decay is substantially lower than database-driven systems. As an added bonus, these static pages require less bandwidth. Our hope is that our approach can help beginners or veterans deploy beautiful editions with less effort, that it can help us teach a 'full stack' [in one academic semester](https://github.com/susannalles/MinimalEditions/blob/master/index.md), allow us to care for our projects at less cost, and perhaps, just perhaps, allow us to generate high-quality editions on github.io in large quantities based on the [git-lit](http://jonreeve.com/2015/09/introducing-git-lit/) model by Jonathan Reeve. We're coming for you, Kindle!
10+
Ed is a [Jekyll](https://jekyllrb.com/) theme designed for textual editors based on
11+
[minimal computing](http://go-dh.github.io/mincomp/) principles, and focused on legibility,
12+
durability, ease and flexibility.
13+
14+
One of our most pressing and ever revolving needs as scholars is to pass on our textual artifacts
15+
from one generation to another. The art of textual editing, among other practices, has helped many
16+
cultures to remember and interpret for centuries. Alas, that art is practiced and encouraged in its
17+
highest form by a dwindling number of scholars. In a digital environment the problem is compounded
18+
by the difficulties of the medium. While vast repositories, and "e-publications" appear on the
19+
online scene yearly, very few manifest a textual scholar's disciplined attention to detail. In
20+
contrast, most textual scholars who have made the leap to a rigorous digital practice have focused
21+
on markup, relying on technical teams to deploy and maintain their work. This makes your average
22+
scholarly digital edition a very costly, and therefore limited affair.
23+
24+
As we see it, a minimal edition is one that aims to reduce the size and complexity of the back and
25+
front end, and the learning curves for the user and the producer. Out of-the-box, this theme can
26+
help you build a simple reading edition, or a traditional scholarly edition with footnotes and a
27+
bibliography without breaking the bank. In our estimate, these are the two most immediately useful
28+
type of editions for editors and readers. An edition produced with Ed consists of static pages whose
29+
rate of decay is substantially lower than database-driven systems. As an added bonus, these static
30+
pages require less bandwidth. Our hope is that our approach can help beginners or veterans deploy
31+
beautiful editions with less effort, that it can help us teach a 'full stack'
32+
[in one academic semester](https://github.com/susannalles/MinimalEditions/blob/master/index.md),
33+
allow us to care for our projects at less cost, and perhaps, just perhaps, allow us to generate
34+
high-quality editions on github.io in large quantities based on the
35+
[git-lit](http://jonreeve.com/2015/09/introducing-git-lit/) model by Jonathan Reeve. We're coming
36+
for you, Kindle!
1837

1938

2039
## Sample Ed editions.
@@ -26,8 +45,8 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
2645
- [Daisy Miller: A Comedy in Three Acts](https://britaneeelizabeth.github.io/ed/texts/DaisyMillerPlay/)
2746

2847

29-
3048
## Current Features
49+
3150
- Templates for narrative, drama and poetry
3251
- Responsive design for mobile phones, tablets and PCs.
3352
- Relatively easy to learn and teach
@@ -44,4 +63,5 @@ As we see it, a minimal edition is one that aims to reduce the size and complexi
4463

4564
## Installing and using Ed
4665

47-
To learn how to install and begin using Ed, please visit our [documentation page](http://minicomp.github.io/ed/documentation).
66+
To learn how to install and begin using Ed, please visit our
67+
[documentation page](http://minicomp.github.io/ed/documentation).

0 commit comments

Comments
 (0)