Giter Site home page Giter Site logo

xi-mac's Introduction

A modern editor with a backend written in Rust.

The xi editor project is an attempt to build a high quality text editor, using modern software engineering techniques. It is initially built for Mac OS X, using Cocoa for the user interface, but other targets are planned.

Goals include:

  • Incredibly high performance. All editing operations should commit and paint in under 16ms. The editor should never make you wait for anything.

  • Beauty. The editor should fit well on a modern desktop, and not look like a throwback from the โ€™80s or โ€™90s. Text drawing should be done with the best technology available (Core Text on Mac, DirectWrite on Windows, etc.), and support Unicode fully.

  • Reliability. Crashing, hanging, or losing work should never happen.

  • Developer friendliness. It should be easy to customize xi editor, whether by adding plug-ins or hacking on the core.

Screenshot (will need to be updated as syntax coloring and UI polish is added):

xi screenshot

Getting started

You need Xcode 8.2 (only on Mac) and Rust (version 1.13+ is recommended and supported). You should have cargo in your path. You'll also need cmake installed, to run the syntax highlighter. If you have homebrew, easiest to run brew install cmake. It is possible to build without cmake, but requires some editing of build scripts.

Note: the front-end and back-end are now split into two separate repositories. This is the front-end, and the back-end (or core) is now in: xi-editor. Make sure to have that checked out as a subdirectory.

> git clone https://github.com/google/xi-mac
> cd xi-mac
> git clone https://github.com/google/xi-editor
> xcodebuild
> open build/Release/XiEditor.app

Or open XiEditor.xcodeproj and hit the Run button.

It will look better if you have InconsolataGo installed, a customized version of Inconsolata tuned for code editing. You can change fonts per window in the Font menu or with Cmd-Shift-T. To choose another default font, edit the CTFontCreateWithName() call in EditView.swift.

Authors

The main author is Raph Levien.

Contributions

We gladly accept contributions via GitHub pull requests, as long as the author has signed the Google Contributor License. Please see CONTRIBUTING.md for more details.

Disclaimer

This is not an official Google product (experimental or otherwise), it is just code that happens to be owned by Google.

xi-mac's People

Contributors

aquageek avatar cbrewster avatar chancywu avatar cmyr avatar divinedominion avatar gbear605 avatar hjylewis avatar jdub avatar jessefarebro avatar kamyuentse avatar kmikael avatar lucasprag avatar manuel-rhdt avatar modelorganism avatar pocket7878 avatar porglezomp avatar raphlinus avatar rkusa avatar rtsuk avatar tsekityam avatar yansal avatar z11h avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.