go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-13 01:47:51 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
2c9b189400
elvish/README.md

35 lines
3.0 KiB
Markdown
Raw Normal View History

New title and description. Elvish is now a cross-platform shell instead of an UNIX shell, yay \o/
2018-01-01 05:25:20 +08:00
# Elvish: Friendly and Expressive Shell
add a README
2013-06-16 16:45:22 +08:00
Update README.md Provide a walkthrough of how to become a master Elf.
2018-10-10 00:14:39 +08:00
Elvish is a friendly and expressive shell for Linux, BSDs, macOS and Windows. Despite being pre-1.0 software, it is already suitable for most daily interactive use.
Update README.md
2018-01-01 05:53:35 +08:00
Add logos to build badges.
2018-02-10 03:21:13 +08:00
[![Build Status on Travis](https://img.shields.io/travis/elves/elvish.svg?logo=travis&label=linux%20%26%20macOS)](https://travis-ci.org/elves/elvish)
Update README.md
2018-01-01 05:53:35 +08:00
[![Build status on AppVeyor](https://img.shields.io/appveyor/ci/xiaq/elvish.svg?logo=appveyor&label=windows)](https://ci.appveyor.com/project/xiaq/elvish)
Add logos to build badges.
2018-02-10 03:21:13 +08:00
[![Build Status on VSTS](https://img.shields.io/vso/build/xiaq/13c48a6c-b2dc-472e-af6c-169bf448f8e6/1.svg?logo=tfs&label=macOS)](https://xiaq.visualstudio.com/elvish/_build)
Use shields.io coverage badges
2017-12-27 01:04:52 +08:00
[![Code Coverage on codecov.io](https://img.shields.io/codecov/c/github/elves/elvish.svg?label=codecov)](https://codecov.io/gh/elves/elvish)
[![Code Coverage on coveralls.io](https://img.shields.io/coveralls/github/elves/elvish.svg?label=coveralls)](https://coveralls.io/github/elves/elvish)
Add another useless badge, the Go Report Card.
2017-05-22 00:41:56 +08:00
[![Go Report Card](https://goreportcard.com/badge/github.com/elves/elvish)](https://goreportcard.com/report/github.com/elves/elvish)
Update README.md
2018-01-01 05:53:35 +08:00
[![GoDoc](https://img.shields.io/badge/godoc-api-blue.svg)](http://godoc.org/github.com/elves/elvish)
Make badges fit in one line again.
2018-02-10 03:22:56 +08:00
[![License](https://img.shields.io/badge/BSD-2--clause-blue.svg)](https://github.com/elves/elvish/blob/master/LICENSE)
Add more social badges to README
2017-07-07 01:36:27 +08:00
Update README.md
2018-10-09 23:59:16 +08:00
[![Gitter](https://img.shields.io/badge/gitter-elves/elvish--public-blue.svg?logo=gitter-white)](https://gitter.im/elves/elvish-public)
README.md: Better badges \o/
2017-12-16 21:47:28 +08:00
[![Telegram Group](https://img.shields.io/badge/telegram-@elvish-blue.svg)](https://telegram.me/elvish)
[![#elvish on freenode](https://img.shields.io/badge/freenode-%23elvish-blue.svg)](https://webchat.freenode.net/?channels=elvish)
Update README.md
2018-10-09 23:59:16 +08:00
[![Gitter for Developers](https://img.shields.io/badge/gitter-elves/elvish--dev-000000.svg?logo=gitter-white)](https://gitter.im/elves/elvish-dev)
Update README.md
2018-01-01 05:53:35 +08:00
[![Telegram Group for Developers](https://img.shields.io/badge/telegram-@elvish__dev-000000.svg)](https://telegram.me/elvish_dev)
[![#elvish-dev on freenode](https://img.shields.io/badge/freenode-%23elvish--dev-000000.svg)](https://webchat.freenode.net/?channels=elvish-dev)
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/RealElvishShell)
Rework README.
2017-07-07 08:08:41 +08:00
Update README.md Move the walkthrough before the CONTRIBUTING.md link.
2018-10-10 00:18:56 +08:00
Here are some simple steps of becoming a master Elf (all links go to the [official website](https://elv.sh)):
Update README.md
2018-10-09 23:59:16 +08:00
Update README.md Provide a walkthrough of how to become a master Elf.
2018-10-10 00:14:39 +08:00
1. [Download](https://elv.sh/download/) a binary for your platform.
Update README.md Move the walkthrough before the CONTRIBUTING.md link.
2018-10-10 00:18:56 +08:00
2. Get started with examples from the [cookbook](https://elv.sh/learn/cookbook.html).
Update README.md Provide a walkthrough of how to become a master Elf.
2018-10-10 00:14:39 +08:00
3. Read [the reference section](https://elv.sh/ref/) to understand Elvish as a programming language; in particular, read the [language reference](https://elv.sh/ref/language.html) and the [builtin module reference](https://elv.sh/ref/builtin.html).
4. Get familiar with how to write [Effective Elvish](https://elv.sh/learn/effective-elvish.html). This is a living document that evolves with the Elvish language itself.
README: build via homebrew (#210)
2016-09-14 18:40:34 +08:00
README: Reword the contributing paragraph.
2018-10-10 00:42:57 +08:00
Regardless of whether you consider yourself a master Elf, feel free to
contribute! Read [CONTRIBUTING.md](CONTRIBUTING.md) for some notes for
contributors.
Reference in New Issue Copy Permalink