Update docs and makefile

This commit is contained in:
Zachary Yedidia 2016-08-27 22:00:56 -04:00
parent 0a3e2b3ff0
commit da7bc997ff
6 changed files with 37 additions and 22 deletions

View file

@ -3,18 +3,37 @@
VERSION = $(shell git describe --tags --abbrev=0) VERSION = $(shell git describe --tags --abbrev=0)
HASH = $(shell git rev-parse --short HEAD) HASH = $(shell git rev-parse --short HEAD)
build: tcell # Builds micro after checking dependencies but without updating the runtime
build: deps tcell
go build -ldflags "-X main.Version=$(VERSION) -X main.CommitHash=$(HASH) -X 'main.CompileDate=$(shell date -u '+%B %d, %Y')'" -o micro ./cmd/micro go build -ldflags "-X main.Version=$(VERSION) -X main.CommitHash=$(HASH) -X 'main.CompileDate=$(shell date -u '+%B %d, %Y')'" -o micro ./cmd/micro
# Builds micro after building the runtiem and checking dependencies
build-all: runtime build
# Builds micro without checking for dependencies
build-quick:
go build -ldflags "-X main.Version=$(VERSION) -X main.CommitHash=$(HASH) -X 'main.CompileDate=$(shell date -u '+%B %d, %Y')'" -o micro ./cmd/micro
# Same as 'build' but installs to $GOPATH/bin afterward
install: build install: build
mv micro $(GOPATH)/bin mv micro $(GOPATH)/bin
# Same as 'build-all' but installs to $GOPATH/bin afterward
install-all: runtime install
# Same as 'build-quick' but installs to $GOPATH/bin afterward
install-quick: build-quick
mv micro $(GOPATH)/bin
# Updates tcell
tcell: tcell:
git -C $(GOPATH)/src/github.com/zyedidia/tcell pull git -C $(GOPATH)/src/github.com/zyedidia/tcell pull
# Checks for dependencies
deps: deps:
go get -d ./cmd/micro go get -d ./cmd/micro
# Builds the runtime
runtime: runtime:
go get -u github.com/jteeuwen/go-bindata/... go get -u github.com/jteeuwen/go-bindata/...
$(GOPATH)/bin/go-bindata -nometadata -o runtime.go runtime/... $(GOPATH)/bin/go-bindata -nometadata -o runtime.go runtime/...

File diff suppressed because one or more lines are too long

View file

@ -12,6 +12,9 @@ Micro comes with a number of colorschemes by default. Here is the list:
* default: this is the simplest colorscheme. It uses 16 colors which are * default: this is the simplest colorscheme. It uses 16 colors which are
set by your terminal set by your terminal
* zenburn: this is micro's default colorscheme because it looks very good
and works in 256 color terminals.
* solarized: this is the solarized colorscheme. * solarized: this is the solarized colorscheme.
You should have the solarized color palette in your terminal to use it. You should have the solarized color palette in your terminal to use it.
@ -19,8 +22,8 @@ Micro comes with a number of colorschemes by default. Here is the list:
make sure your terminal supports true color before using it and that the make sure your terminal supports true color before using it and that the
MICRO_TRUECOLOR environment variable is set to 1 before starting micro. MICRO_TRUECOLOR environment variable is set to 1 before starting micro.
* monokai: this is the monokai colorscheme and is micro's default colorscheme * monokai: this is the monokai colorscheme, you may recognize it as
(as well as sublime text's). It requires true color to sublime text's default colorscheme. It requires true color to
look perfect, but the 256 color approximation looks very good as well. look perfect, but the 256 color approximation looks very good as well.
* atom-dark-tc: this colorscheme is based off of Atom's "dark" colorscheme. * atom-dark-tc: this colorscheme is based off of Atom's "dark" colorscheme.

View file

@ -12,6 +12,7 @@ Typing help followed by nothing will open this page.
Here are the possible help topics that you can read: Here are the possible help topics that you can read:
* tutorial: A brief tutorial which gives an overview of all the other help topics
* keybindings: Gives a full list of the default keybindings as well as how to rebind them * keybindings: Gives a full list of the default keybindings as well as how to rebind them
* commands: Gives a list of all the commands and what they do * commands: Gives a list of all the commands and what they do
* options: Gives a list of all the options you can customize * options: Gives a list of all the options you can customize
@ -21,6 +22,10 @@ Here are the possible help topics that you can read:
For example to open the help page on plugins you would press CtrlE and type `help plugins`. For example to open the help page on plugins you would press CtrlE and type `help plugins`.
I recommend looking at the `tutorial` help file because it is short for each section and
gives concrete examples of how to use the various configuration options in micro. However,
it does not give the in-depth documentation that the other topics provide.
### Usage ### Usage
Once you have built the editor, simply start it by running Once you have built the editor, simply start it by running

View file

@ -136,6 +136,7 @@ InsertNewline
InsertSpace InsertSpace
Backspace Backspace
Delete Delete
Center
InsertTab InsertTab
Save Save
Find Find

View file

@ -20,21 +20,8 @@ Here are the options that you can set:
~/.config/micro/colorschemes/ directory. Micro comes by default with three ~/.config/micro/colorschemes/ directory. Micro comes by default with three
colorschemes: colorschemes:
* default: this is the default colorscheme. You can read more about micro's colorschemes in the `colors` help topic
(`help colors`).
* solarized: this is the solarized colorscheme (used in the screenshot).
You should have the solarized color palette in your terminal to use it.
* solarized-tc: this is the solarized colorscheme for true color, just
make sure your terminal supports true color before using it and that the
MICRO_TRUECOLOR environment variable is set to 1 before starting micro.
* monokai-tc: this is the monokai colorscheme. It requires true color to
look perfect, but the 256 color approximation looks good as well.
* atom-dark-tc: this colorscheme is based off of Atom's "dark" colorscheme.
It requires true color to look good.
* `tabsize`: sets the tab size to `option` * `tabsize`: sets the tab size to `option`