Skip to content

Commit

Permalink
Adjust readme according to automated releases
Browse files Browse the repository at this point in the history
Close #145
  • Loading branch information
dahlia committed Feb 18, 2018
1 parent 12a5ff2 commit 9a6da6c
Show file tree
Hide file tree
Showing 4 changed files with 58 additions and 30 deletions.
1 change: 1 addition & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ deploy:
file_glob: yes
file: /tmp/nirum-build/*
name: "$TRAVIS_TAG"
prerelease: yes

after_deploy: |
[[ "$TRAVIS_TAG" != "" && "$TRAVIS_OS_NAME" = "linux" ]] || exit 0
Expand Down
78 changes: 52 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Nirum
=====

[![The latest release on GitHub][release-svg]][release]
[![The latest release on GitHub][release-svg]][releases]
[![Docker automated build][docker-svg]][docker]
[![Build status on Linux and macOS (Travis CI)][ci-svg]][ci]
[![Build status on Windows (AppVeyor)][ciw-svg]][ciw]
Expand All @@ -10,7 +10,7 @@ Nirum
[![Gitter][chat-svg]][chat]

[release-svg]: https://img.shields.io/github/release/spoqa/nirum/all.svg
[release]: https://github.com/spoqa/nirum/releases
[releases]: https://github.com/spoqa/nirum/releases
[docker]: https://hub.docker.com/r/spoqa/nirum/
[docker-svg]: https://img.shields.io/docker/automated/spoqa/nirum.svg
[ci-svg]: https://travis-ci.org/spoqa/nirum.svg?branch=master
Expand All @@ -24,8 +24,8 @@ Nirum
[chat-svg]: https://badges.gitter.im/spoqa/nirum.svg
[chat]: https://gitter.im/spoqa/nirum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge

Nirum is an [IDL][1] compiler and [RPC][2]/[distributed object][3] framework
for [microservices][4], built on top of the modern Web server technologies
Nirum is an [IDL] compiler and [RPC]/[distributed object] framework
for [microservices], built on top of the modern Web server technologies
such as RESTful HTTP and JSON.

You can find how the language looks like from source codes in the `examples/`
Expand All @@ -34,24 +34,50 @@ directory.
**Note that its design is highly unstable and could be changed.**
Also the feature set is incomplete yet.

[1]: https://en.wikipedia.org/wiki/Interface_description_language
[2]: https://en.wikipedia.org/wiki/Remote_procedure_call
[3]: https://en.wikipedia.org/wiki/Distributed_object
[4]: https://en.wikipedia.org/wiki/Microservices
[IDL]: https://en.wikipedia.org/wiki/Interface_description_language
[RPC]: https://en.wikipedia.org/wiki/Remote_procedure_call
[distributed object]: https://en.wikipedia.org/wiki/Distributed_object
[microservices]: https://en.wikipedia.org/wiki/Microservices


Nightly builds
--------------
Installation
------------

The easiest way to give a try to use Nirum is downloading a nightly build.
We currently provides the prebuilt binaries of the following platforms:
The Nirum compiler works on the most major platforms like Linux, macOS, and
Windows. We provide the prebuilt executable binaries for these three platforms.


### Released builds

You can download a executable binary for Linux (x86_64), macOS (x86_64), or
Windows (x64 or x86) from the [latest release note][latest-release].
You should give it appropriate permissions (e.g., `+x`) depending on your
platform.

If you look for a previous release, see the [list of all releases][releases].

We provide official Docker images as well. You can check the list of
[released tags][docker-tags]. *Note that `latest` is for a nightly build which
is unstable (see below).*

[latest-release]: https://github.com/spoqa/nirum/releases/latest
[docker-tags]: https://hub.docker.com/r/spoqa/nirum/tags/


### Nightly builds

Since Nirum is still changing by leaps and bounds, you could want to try
its bleeding edge. We provide nightly builds for this purpose.

- [Linux (x86_64)](https://nightly-builds.nirum.org/travis-builds/nirum-linux-x86_64)
- [Mac (x86_64)](https://nightly-builds.nirum.org/travis-builds/nirum-darwin-x86_64)
- [macOS (x86_64)](https://nightly-builds.nirum.org/travis-builds/nirum-darwin-x86_64)
- [Windows (x64)](https://ci.appveyor.com/api/projects/dahlia/nirum-k5n5y/artifacts/nirum-win-x64.exe?job=Platform%3A%20x64&branch=master)
- [Windows (x86)](https://ci.appveyor.com/api/projects/dahlia/nirum-k5n5y/artifacts/nirum-win-x86.exe?job=Platform%3A%20x86&branch=master)
- [Docker (`spoqa/nirum:latest`)][docker]

Although we call it "nightly build," technically it is not built every night,
but done every merge commit.


Getting started
---------------
Expand Down Expand Up @@ -82,7 +108,7 @@ There is a [step-by-step tutorial](./docs/tutorial.md) as well.
Building
--------

If you already installed [Haskell Stack][5], you can build the project
If you already installed [Haskell Stack], you can build the project
in the same way to build other Haskell softwares:

$ stack build
Expand All @@ -94,15 +120,15 @@ You can run the test suite of Nirum:

For details, please read the [contribution guide](./CONTRIBUTING.md).

[5]: https://www.haskellstack.org/
[Haskell Stack]: https://www.haskellstack.org/


Related projects & tools
------------------------

See also the [list of Nirum-related projects][7] on GitHub. Have you kicked off
a new project related to Nirum? Please add *nirum* [topic][8] to your project
on GitHub!
See also the [list of Nirum-related projects][related-projects] on GitHub.
Have you kicked off a new project related to Nirum? Please add *nirum*
[topic][github-topic] to your project on GitHub!

### Language runtimes

Expand All @@ -117,23 +143,23 @@ on GitHub!

- [nirum.tmbundle](https://github.com/spoqa/nirum.tmbundle): TextMate bundle
for Nirum. Also can be used by IntelliJ IDEA (or any other JetBrain's
IDEs, e.g., PyCharm, WebStorm) through [TextMate bundles support][9].
IDEs, e.g., PyCharm, WebStorm) through [TextMate bundles support].
- [nirum.vim](https://github.com/spoqa/nirum.vim): Nirum syntax highlighter for
Vim/Neovim.
- [sublime-nirum](https://github.com/spoqa/sublime-nirum): Nirum package for
Sublime Text 3.

[7]: https://github.com/search?q=topic:nirum+fork:false
[8]: https://github.com/blog/2309-introducing-topics
[9]: https://github.com/spoqa/nirum.tmbundle#installation-intellij-idea-pycharm-etc
[related-projects]: https://github.com/search?q=topic:nirum+fork:false
[github-topic]: https://github.com/blog/2309-introducing-topics
[TextMate bundles support]: https://github.com/spoqa/nirum.tmbundle#installation-intellij-idea-pycharm-etc


Etymology
---------

**니름** (IPA: /niɾɯm/; *nireum*) is a sort of telepathy in the fictional world
of [The Bird That Drinks Tears][9] (눈물을 마시는 새 *Nunmureul masineun sae*)
by [Lee Yeongdo][10] (이영도).
of [The Bird That Drinks Tears] (눈물을 마시는 새 *Nunmureul masineun sae*)
by [Lee Yeongdo] (이영도).

[9]: https://en.wikipedia.org/wiki/The_Bird_That_Drinks_Tears
[10]: https://en.wikipedia.org/wiki/Lee_Yeongdo
[The Bird That Drinks Tears]: https://en.wikipedia.org/wiki/The_Bird_That_Drinks_Tears
[Lee Yeongdo]: https://en.wikipedia.org/wiki/Lee_Yeongdo
1 change: 1 addition & 0 deletions appveyor.yml
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,4 @@ deploy:
release: "$(appveyor_repo_tag_name)"
description: "$(appveyor_repo_tag_name)"
artifact: /.*\.exe/
prerelease: true
8 changes: 4 additions & 4 deletions docs/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,9 @@ Installing compiler
-------------------

The Nirum compiler works on the most major platforms like Linux, macOS, and
Windows. The [official website][] provides the prebuilt executable binaries
for these three platforms. Note that there is no stable version as of
February 2018.
Windows. The [official releases page][] provides the prebuilt executable
binaries for these three platforms. Note that there is no stable version
(i.e., v1.0.0 or higher) as of February 2018.

This tutorial assumes that you have:

Expand All @@ -138,7 +138,7 @@ $ nirum -v
0.3.0
~~~~~~~~

[official website]: http://nirum.org/
[official releases page]: https://github.com/spoqa/nirum/releases


Service interface
Expand Down

0 comments on commit 9a6da6c

Please sign in to comment.