corinthia-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From orc...@apache.org
Subject incubator-corinthia git commit: README.md Transposed for Apache Incubator
Date Thu, 18 Dec 2014 19:36:25 GMT
Repository: incubator-corinthia
Updated Branches:
  refs/heads/master 4d3a7c209 -> 76d9bc38e


README.md Transposed for Apache Incubator

The README.md is updated to reflect this repository being part of the
Apache Corinthia (incubating) project.


Project: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/commit/76d9bc38
Tree: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/tree/76d9bc38
Diff: http://git-wip-us.apache.org/repos/asf/incubator-corinthia/diff/76d9bc38

Branch: refs/heads/master
Commit: 76d9bc38e287748d06179c1c7bc36ad5108e59c6
Parents: 4d3a7c2
Author: Dennis Hamilton <orcmid@apache.org>
Authored: Thu Dec 18 11:36:09 2014 -0800
Committer: Dennis Hamilton <orcmid@apache.org>
Committed: Thu Dec 18 11:36:09 2014 -0800

----------------------------------------------------------------------
 README.md | 80 +++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 49 insertions(+), 31 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/76d9bc38/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 28519a0..16d889b 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,38 @@
-# About Corinthia
+# About Apache Corinthia (incubating)
 
-Corinthia is a library for converting between different word processing file
-formats. Currently it supports .docx (part of the OOXML specification), HTML,
-and LaTeX (export-only). Corinthia also contain convinience executables.
+Corinthia is a library for converting between different word-processing file
+formats. Initially, it supports .docx (part of the OOXML specification), HTML,
+and LaTeX (export-only). The Corinthia project also provides convenience
+executables.  The library has shipped as part of
+[UX Write](http://www.uxproductivity.com/) since February 2013.
 
-We are putting together a proposal to make this an Apache Incubator project. [See here for
details](https://github.com/uxproductivity/Corinthia/wiki/Incubator-proposal#abstract)
+On December 8, 2014, Corinthia entered the Apache Software
+Foundation
+[incubator](http://incubator.apache.org/incubation/Process_Description.html).
+The
+[accepted proposal](http://wiki.apache.org/incubator/CorinthiaProposal) and
+[incubation status](http://incubator.apache.org/projects/corinthia.html)
+provide incubation background and progress information.
 
-For more information, contact any of the following people
+The communication hub of the project is the development mailing list,
 
-- Peter Kelly <peter@uxproductivity.com>
-- Louis Suárez-Potts <luispo@gmail.com>
-- Jan Iverson <jani@apache.org>
+    dev @ corinthia.incubator.apache.org
 
-Please note that the documentation for this project is in a very preliminary stage. We'll
be improving this in due course; feel free to contact us with any questions.
+To receive list postings and interact on the list, simply send a message to
+
+   dev-subscribe @ corinthia.incubator.apache.org
+
+from the email address to receive list messages at.  The reply from
+the list robot to that address provides confirmation instructions and
+information on managing the subscription.
+
+There is a [Corinthia incubator web
+site](http://corinthia.incubator.apache.org/) and there will be a project
+wiki and JIRA issue tracker.
+
+The sites and documentation for this project are at a preliminary
+stage. Content will be moved to Apache and improved as incubation moves
+ahead.
 
 # License
 
@@ -26,7 +46,8 @@ LICENSE.txt for details.
 3. Update existing .docx files based on a modified HTML file produced in (1)
 4. Convert .docx or HTML files to LaTeX
 5. Provide access to document structure, in terms of a DOM-like API for
-   manipulating XML trees, and an object model for working with CSS stylesheets
+   manipulating XML trees, and an object model for working with CSS
+   stylesheets
 
 # Components
 
@@ -36,29 +57,24 @@ There are three major components, in their respective directories:
 * `dfutil` - a driver program used for running [...]
 * automated tests (located in the tests directory)
 
-Run dfutil without any command-line arguments to see a list of operations. Here
-is an example of converting a .docx file to HTML, modifying it, and then updating
-the original .docx. Note that it is important, due to how internal mapping works,
-that the .docx file being written is the same file as the original; using a new
-file won't work.
+Run dfutil without any command-line arguments to see a list of operations.
+Here is an example of converting a .docx file to HTML, modifying it, and then
+updating the original .docx. Note that it is important, due to how internal
+mapping works, that the .docx file being written is the same file as the
+original; using a new file won't work.
 
     dfutil filename.docx filename.html
     vi filename.html # Make some changes
     dfutil filename.html filename.docx
 
-If you examine the convertFile function in `dfutil/Commands.c`, you will see the
-main entry points to perform these conversions, which you can call from your own
-program.
-
-# Current Status
-DocFormats has been shipping as part of UX Write on the iOS app store since
-February 2013.
-
-[detailed status](https://github.com/uxproductivity/Corinthia/wiki/Incubator-proposal#current-status)
+If you examine the convertFile function in `dfutil/Commands.c`, you will see
+the main entry points to perform these conversions, which you can call from
+your own program.
 
 # Platforms and dependencies
 
-Corinthia builds and runs on iOS, OS X, and Linux. Windows support is in the works.
+Corinthia builds and runs on iOS, OS X, and Linux. Windows support is in the
+works.
 
 To build DocFormats, you will need to have the following installed:
 
@@ -69,12 +85,14 @@ To build DocFormats, you will need to have the following installed:
 
 # Build instructions
 
-Corinthia currently build on Linux and OS X (mac).
+Corinthia currently builds on Linux and OS X (mac). See the [build  instructions](https://github.com/uxproductivity/Corinthia/wiki/Build-instructions).
+
+# Contributing
 
-For detailed instructions, please see
+Contributors are welcome and prized.  Details on how to participate on the
+project will be posted soon.
 
-[build instructions](https://github.com/uxproductivity/Corinthia/wiki/Build-instructions)
+Meanwhile, the easiest way to contribute is by subscribing to the development
+list and asking your questions and offering suggestions there.
 
-# Further information
 
-please see [mail list](https://github.com/uxproductivity/Corinthia/wiki/Talk-to-us) for contacts


Mime
View raw message