Skip to content

Latest commit

 

History

History
53 lines (38 loc) · 2.24 KB

README.md

File metadata and controls

53 lines (38 loc) · 2.24 KB

Uffice

uffice

Uffice is an alpha-stage word processor, working on compatibility with WordprocessingML format of the Office Open Specification (ECMA-376).

Demo of the uffice application on Windows.

Installation

As the software is alpha-stage, the user experience is yet to be. You can simply clone this repository and use Cargo to build the project.

# Clone using HTTP:
git clone https://github.com/usadson/uffice

# or using SSH:
git clone [email protected]:usadson/uffice.git

cd uffice

# Build the application
cargo build

Usage

The application is currently in alpha-stage, and is not yet ready for production use. However, you can still use it to open documents. Editing is not yet supported, but work is being done to add this feature.

Currently, files can be opened by specifying their path as arguments to the application. For example, to open the test.docx file, you can run the following command:

cargo run -- test.docx

A user-interface is still being worked on, but you can drag & drop documents onto the application window to open them.

UX Checklist

The following checklist documents the requirements that have to put in place to help aid new users, installations and usages of the application.

  • Add a CI/CD pipeline
  • Provide production-ready binaries
  • Publish a release
  • Add a user interface to open files
  • Add a greeting screen, welcoming the user to open a document
  • Remove the UFFICE_TEST_FILE environment variable

Reference Material

Licensing

This project is currently licensed under a BSD-2-Clause-compatible license, but uses various dependencies, with distinct licenses each.

Legal

For any legal questions or issues, including patents and IP, please contact me via email or Twitter.