Skip to content

Commit

Permalink
copy edits
Browse files Browse the repository at this point in the history
  • Loading branch information
priyatam committed Jul 31, 2014
1 parent 28bc66e commit 68214d9
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
26 changes: 12 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@
Zenup
=====
Zendown
=======

A markup for writing poems and stories.

Inspired by [Jekyll blogs](http://jekyllrb.com/docs/home/), and composed of [YAML](http://en.wikipedia.org/wiki/YAML), Plaintext, or [Markdown](http://daringfireball.net/projects/markdown/).

## Introduction

Thousands of poems and stories in the public domain live buried in libraries, archaic websites, and journals gone out of print. Emerging writers publish their literature online where magazines save them in content management systems, programs that strip and lock literature in complex, proprietary software.
Thousands of poems and stories in the public domain live buried in libraries, archaic websites, and journals gone out of print. Emerging writers publish their literature online where magazines save them in content management systems, programs that strip and lock literature in complex, proprietary software. We don't have an open format to share literature on the web.

We don't have an open format to share literature on the web.
Zendown allows you to write poems and stories using an easy-to-read, easy-to-write, plain-text or markdown format, interchangeably. Scripts can convert them to a [HTML5](http://en.wikipedia.org/wiki/HTML5) understood by modern browsers on desktop, mobile, and web. The goal is that poems and stories should be publishable and restored as-is, as plain-text, before being consumed by content management systems.

Zenup allows you to write poems and stories using an easy-to-read, easy-to-write, plain-text or markdown format, interchangeably. Scripts can convert them to a [HTML5](http://en.wikipedia.org/wiki/HTML5) understood by modern browsers on desktop, mobile, and web. The goal is that poems and stories should be publishable and restored as-is, as plain-text, before being consumed by content management systems.

Zenup is free software, available under a BSD-style open source license.
Zendown is free software, available under a BSD-style open source license.

## SPEC

See [SPEC.md](/SPEC.md) for more details.

## Editor Support
## Editors

Markdown content can be opened in any Markdown-supported Editor.

Expand All @@ -32,20 +30,20 @@ Saving a file in UTF-8 is a necessary, important step, to preserve foreign-langu

## Scripts

Scripts are available under `/scripts`.
Scripts are available under `/scripts`.

A default script is written in Clojure. Scripts in Python and Javascript will be implemented soon. Writing scripts in other languagse is trivial, given that YAML and Markdown are widely used and are backed by open parsers, in a language of your choice.
A default script is written in Clojure. Scripts in Python and Javascript will be implemented soon. Writing scripts in other languagse is trivial, given that YAML and Markdown are widely used and backed by robust parsers, in a language of your choice.

## Status

This is a working draft.

Currently, Zenup is being used by [Facjure](https://github.com/facjure/public-domain-poetry), to restore thousands of poems and stories.
Currently, Zendown is being used by [Facjure](https://github.com/facjure/public-domain-poetry), to restore thousands of poems and stories.

## Credits
## Acknowledgements

- [Ata Moharreri](https://twitter.com/AtaMoharreri), for curating 1600 poems during our initial adoption
- [Sreeharsha Mudivarti](http://lexical.foobar.systems), for research and early prototyping
- [Ata Moharreri](https://twitter.com/AtaMoharreri), for curating 1600 poems in [Zendown]()
- [Sreeharsha Mudivarti](http://lexical.foobar.systems), for research

## Copyright & License

Expand Down
12 changes: 7 additions & 5 deletions SPEC.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Zenup Spec
# Zendown Spec

Zenup's syntax is a combination of YAML metadata and Content.
Zendown's syntax is a combination of YAML metadata and Content.

## METADATA

Expand All @@ -27,9 +27,9 @@ Note the "space" after ":" and "-", `---` before and after the metadata.

**Plaintext**

By default all Zenup content is [Plain Text](http://en.wikipedia.org/wiki/Plain_text), still an excellent format supported by default in all editors.
By default all Zenup content is [Plain Text](http://en.wikipedia.org/wiki/Plain_text), still an excellent format supported by default in all editors.

Many times poems require whitespace to be preserved "as-is"—a necessity to illustrate a poem's visual semantics and line endings.
Many times poems require whitespace to be preserved "as-is"—a necessity to illustrate a poem's visual semantics and line endings.

```
---
Expand Down Expand Up @@ -83,12 +83,14 @@ Coming soon.

## Other formats

While support for other plain-text formats like [asciidoc](http://www.methods.co.nz/asciidoc/) or [docbook](http://www.docbook.org) is possible, Zenup aims to keep things simple.
While support for other plain-text formats like [asciidoc](http://www.methods.co.nz/asciidoc/) or [docbook](http://www.docbook.org) is possible, Zenup aims to keep things simple.

For document conversions from popular formats, check out [Pandoc](http://johnmacfarlane.net/pandoc/)—an excellent opensource library.

## RULES

Files must be saved as ".zen" or ".txt".

For poems, filenames are saved as:

`first-name-last-name-first-six-words-of-title.txt` OR
Expand Down

0 comments on commit 68214d9

Please sign in to comment.