corinthia-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From pmke...@apache.org
Subject [3/5] incubator-corinthia git commit: DO NOT USE MASTER BRANCH
Date Fri, 19 Dec 2014 08:25:41 GMT
DO NOT USE MASTER BRANCH

This version of the README.md is on the master branch as a warning.  Do
not merge this branch to static or develop and do not merge anything to
the master branch.  It is not used by the Corinthia project at this
time.


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

Branch: refs/heads/stable
Commit: 0e89d37969a133145ca8a59c18f3c4e3d9ea5624
Parents: 6898b0a
Author: Dennis Hamilton <orcmid@apache.org>
Authored: Wed Dec 17 12:44:10 2014 -0800
Committer: Dennis Hamilton <orcmid@apache.org>
Committed: Wed Dec 17 12:44:10 2014 -0800

----------------------------------------------------------------------
 README.md | 79 +++++-----------------------------------------------------
 1 file changed, 6 insertions(+), 73 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-corinthia/blob/0e89d379/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index 28519a0..8e27182 100644
--- a/README.md
+++ b/README.md
@@ -1,80 +1,13 @@
-# About Corinthia
+# DO NOT USE THIS MASTER BRANCH
 
-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.
+The Master Branch of the Corinthia Repository is not used.  It is required for administrative
purposes.
 
-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)
+The main branches to emply are "static" which is clean and "develop" which is not always
clean.
 
-For more information, contact any of the following people
+## DO NOT PUT WORK ON THE MASTER BRANCH.
 
-- Peter Kelly <peter@uxproductivity.com>
-- Louis Suárez-Potts <luispo@gmail.com>
-- Jan Iverson <jani@apache.org>
+## DO NOT MERGE THE MASTER BRANCH.
 
-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.
+If you have cloned this repository and you are seeing this file, please checkout either static
or develop to see the active work on the Apache Corinthia Incubator project.
 
-# License
 
-Corinthia is licensed under the Apache License version 2.0; see
-LICENSE.txt for details.
-
-# What the library can do
-
-1. Create new HTML files from a .docx source
-2. Create new .docx files from a HTML source
-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
-
-# Components
-
-There are three major components, in their respective directories:
-
-* `DocFormats` - the library itself
-* `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.
-
-    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)
-
-# Platforms and dependencies
-
-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:
-
-* [CMake](http://www.cmake.org)
-* [libxml2](http://xmlsoft.org)
-* [libiconv](https://www.gnu.org/software/libiconv/)
-* [zlib](http://www.zlib.net)
-
-# Build instructions
-
-Corinthia currently build on Linux and OS X (mac).
-
-For detailed instructions, please see
-
-[build instructions](https://github.com/uxproductivity/Corinthia/wiki/Build-instructions)
-
-# Further information
-
-please see [mail list](https://github.com/uxproductivity/Corinthia/wiki/Talk-to-us) for contacts


Mime
View raw message