Skip to content

Commit

Permalink
Minor doc tweaks (onivim#507)
Browse files Browse the repository at this point in the history
  • Loading branch information
bryphe authored Jul 31, 2019
1 parent ed7aec4 commit 8a994c2
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 12 deletions.
21 changes: 13 additions & 8 deletions docs/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,27 @@ title: Installation
sidebar_label: Installation
---

While we're developing Onivim 2, the latest builds are available for users who have pre-ordered at our [early access portal](https://v2.onivim.io/early-access-portal).
While we're developing Onivim 2, the latest builds are available at our [early access portal](https://v2.onivim.io/early-access-portal).

## OSX (10.13+)

1. Download `Onivim2.dmg`.
2. Double-click on the downloaded DMG to expand.
3. Drag `Onivim2.App` to the `Applications` Folder, which will make it available in `Launchpad`.

## Windows (x64)

1. Download the Onivim 2 Installer for Windows.
2. Once it is downloaded, run the installer (Onivim 2.exe).
2. Once it is downloaded, run the installer (Onivim2.exe).

> __NOTE:__ Even though the app is code-signed, SmartScreen may show up as the app builds up 'reputation'. Microsoft establishes the reputation of an executable based on the number of installations; so we need to build up some 'reputation'.
>
> Validate that the publisher is listed as "Outrun Labs, LLC" and you can proceed with the installation.
3. By default, the setup program installs Onivim 2 in `C:\Program Files\Onivim2\Oni2.exe`.

## Linux (x64)

1. Download `Onivim2.AppImage`.
2. `$ chmod u+x Onivim2.AppImage`.
3. `$ ./Onivim2.AppImage`.

## OSX (10.13+)

1. Download `Onivim2.dmg`.
2. Double-click on the downloaded DMG to expand.
3. Drag `Onivim2.App` to the `Applications` Folder, which will make it available in `Launchpad`.
8 changes: 4 additions & 4 deletions docs/docs/getting-started/why-onivim.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,24 @@ We appreciate aspects of these editors, as we've taken ideas and inspiration fro

## Principles

Onivim 2 is our ideal code editor - in our vision, the fastest way to go from thought to code.
Onivim 2 is our ideal code editor - in our vision, the fastest way to go from thought to code. We're building it with the following principles in mind:

### Performant

We built Onivim 2 from the ground up to be performant. Our ideal code editor starts up instantly, is extremely responsive, and never makes us wait.

The current trend of code editors is to build them on a web technology stack - which, in our mind, compromises the user experience. The fact is, hybrid applications built with tools like Electron will always be at a deficit compared to a native solution.

Our 'secret sauce' to a performant, native foundation, while enjoying the productivity of the web stack is [ReasonML](https://reasonml.github.io) (which is built on [OCaml](https://ocaml.org) and [Revery](https://outrunlabs.com/revery). We believe a code editor is the perfect environment to put this tech to the test!
Our 'secret sauce' to a performant, native foundation, while enjoying the productivity of the web stack is [ReasonML](https://reasonml.github.io) (which is built on [OCaml](https://ocaml.org) and [Revery](https://outrunlabs.com/revery)). We believe a code editor is the perfect environment to put this tech to the test!

### Modal

Our ideal code editor is modal - allowing you to be __maximally productive__ using __just the keyboard__. There is a learning curve to modal editing, to be sure, but once you've learned it,
it's tough to go back!

Non-modal text editors, like Atom or VSCode, are optimized for _text insertion_. However, most of our work as developers is actually _navigating_ and _editing_ source code files. Modal editing provides a grammar for quickly navigating files.
Non-modal text editors, like Atom or VSCode, are optimized for _text insertion_. However, most of our work as developers is actually _navigating_ and _editing_ source code files. Modal editing provides a grammar for navigating and editing using just the keyboard.

As an example, the `dw` command in Vim is not just about deleting a word - it's actually a combination of a verb (`d` -> `delete`) + a motion (`w` ->`word`). There are many such operators and motions in Vim's modal editing language, and they can be combined in interesting ways - once you learn this, and build that muscle memory, you can edit text at the speed of thought.
As an example, the `dw` command in Vim is not just about deleting a word - it's actually a combination of a _verb_ (`d` -> `delete`) and a _motion_ (`w` ->`word`). There are many such operators and motions in Vim's modal editing language, and they can be combined in interesting ways - once you learn this, and build that muscle memory, you can navigate and edit code as quickly as your fingers can type!

### Modern

Expand Down
9 changes: 9 additions & 0 deletions docs/website/static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,12 @@
text-transform: uppercase;
font-weight: 600 !important;
}

.post a {
color: #61afef;
opacity: 0.9;
}

.post a:hover {
opacity: 1.0;
}

0 comments on commit 8a994c2

Please sign in to comment.