github/zyedidia.micro
2
0
Fork 0
mirror of https://github.com/zyedidia/micro.git synced 2026-03-30 14:47:16 +09:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Zachary Yedidia
2016-08-29 10:17:15 -04:00
parent fccec47ae5
commit bc6c9772cd
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -45,11 +45,7 @@ Although not yet implemented, I hope to add more features such as autocompletion
# Installation # Installation
To install micro, you can download a prebuilt binary, or you can build it from source. To install micro, you can download a [prebuilt binary](https://github.com/zyedidia/micro/releases), or you can build it from source.
Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
means that micro is restricted to the platforms tcell supports. As a result, micro does not support
Plan9, NaCl, and Cygwin (although this may change in the future).
If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro) If you want more information about ways to install micro, see this [wiki page](https://github.com/zyedidia/micro/wiki/Installing-Micro)
@@ -57,7 +53,7 @@ If you want more information about ways to install micro, see this [wiki page](h
All you need to install micro is one file, the binary itself. It's as simple as that! All you need to install micro is one file, the binary itself. It's as simple as that!
You can download the correct binary for your operating system from the [releases](https://github.com/zyedidia/micro/releases). Download the binary from the [releases](https://github.com/zyedidia/micro/releases) page.
On that page you'll see the nightly release, which contains binaries for micro which are built every night, On that page you'll see the nightly release, which contains binaries for micro which are built every night,
and you'll see all the stable releases with the corresponding binaries. and you'll see all the stable releases with the corresponding binaries.
@@ -93,6 +89,12 @@ that micro's default colorscheme won't look very good. You can either set
the colorscheme to `simple`, or download a better terminal emulator, like the colorscheme to `simple`, or download a better terminal emulator, like
mintty or cmder. mintty or cmder.
### Plan9, NaCl, Cygwin
Please note that micro uses the amazing [tcell library](https://github.com/gdamore/tcell), but this
means that micro is restricted to the platforms tcell supports. As a result, micro does not support
Plan9, NaCl, and Cygwin (although this may change in the future).
# Usage # Usage
Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer. Once you have built the editor, simply start it by running `micro path/to/file.txt` or simply `micro` to open an empty buffer.