Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xi-editor/xi-mac

The xi-editor mac frontend.
https://github.com/xi-editor/xi-mac

Last synced: 29 days ago
JSON representation

The xi-editor mac frontend.

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.com/xi-editor/xi-mac.svg?branch=master)](https://travis-ci.com/xi-editor/xi-mac)

[![codecov](https://codecov.io/gh/xi-editor/xi-mac/branch/master/graph/badge.svg)](https://codecov.io/gh/xi-editor/xi-mac)





  Xi Editor


  Xi Editor




(pronounced "Zigh")



A modern editor with a backend written in Rust.



***Note:*** *This project is still in an early state. Prebuilt binaries will be made available once we start creating versioned releases.*



The xi-editor project is an attempt to build a high quality text editor,

using modern software engineering techniques. This reference frontend is

built for macOS, using Cocoa for the user interface, but there are work

in progress frontends for other platforms as well. Consult the

[list in the xi-editor core README](https://github.com/xi-editor/xi-editor#frontends)

for details.



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](/doc/img/xi-mac-screenshot.png?raw=true)



## Getting started



### Requirements



- [Xcode 10.2](https://developer.apple.com/xcode/)

- [Rust](https://www.rust-lang.org/). We test against the latest stable version,

and recommend installing through [rustup](https://rustup.rs).



### Installing



*Note:* the front-end and back-end are split into two separate repositories. This

is the front-end, and the back-end (or core) is now in

[xi-editor](https://github.com/xi-editor/xi-editor). It is contained in a submodule that is checked out during the clone command.



**Clone the repository:**



```bash

> git clone --recurse-submodules https://github.com/xi-editor/xi-mac

> cd xi-mac

```



**Build and Open:**



```bash

> xcodebuild

> open build/Release/XiEditor.app

```



Or



```bash

> open XiEditor.xcodeproj

```



and then hitting the Run button.



**Move to Applications Folder:**



```bash

> cp -r Build/Release/XiEditor.app /Applications

```



### Troubleshooting



The most common cause of a failed build is an outdated version of `rustc`.

If you've installed with rustup, make sure Rust is up to date by running

`rustup update stable`.



## Configuration



User settings are currently stored in files; the general preferences are

located at `~/Library/Application Support/XiEditor/preferences.xiconfig`.

This file can be opened from File > Preferences (⌘ + ,).



The default font for XiEditor is

[Inconsolata](http://levien.com/type/myfonts/inconsolata.html), which

is bundled with the app.



### Theme



A few theme files are bundled with the application. A theme can be selected

from the Debug > Theme menu. There is not yet a mechanism for including

custom themes.



## CLI



XiEditor includes a CLI for opening files directly from the command line.



### Installing



**Through XiEditor:**



1. Install XiEditor

2. Open XiEditor

3. XiEditor > Install Command Line Tool



### Usage



```text

USAGE: xi [ ...] [--wait]



ARGUMENTS:

                   Relative or absolute path to the file(s) to open. If none, opens empty editor.



OPTIONS:

  --wait                  Wait for the editor to close before finishing process.

  -h, --help              Show help information.

```



### Git Editor



Add the following to your `.gitconfig` to use XiEditor as your git editor:



```text

[core]

  editor = xi --wait

```



## Authors



The xi-editor project was started by Raph Levien but has since received

contributions from a number of other people. See the [AUTHORS](AUTHORS)

file for details.



## License



This project is licensed under the Apache 2 [license](LICENSE). The bundled fonts are under a

different license, the Open Font License. See the [fonts](fonts) directory for the fonts and associated

license.



## Contributions



We gladly accept contributions via GitHub pull requests. Please see

[CONTRIBUTING.md](CONTRIBUTING.md) for more details.



If you are interested in contributing but not sure where to start, there is an

active Zulip channel at #xi-editor on https://xi.zulipchat.com. There is also

a #xi channel on irc.mozilla.org. Finally, there is a subreddit at

[/r/xi_editor](https://www.reddit.com/r/xi_editor/).