[nongnu] elpa/julia-mode a1ba9a0 352/352: add logo, README tweaks, add section on testing (#163)

[ELPA Syncer]

branch: elpa/julia-mode
commit a1ba9a03a4b18a0d9536753efee623ab7afca596
Author: Antti Halme <antti.halme@iki.fi>
Commit: GitHub <noreply@github.com>

    add logo, README tweaks, add section on testing (#163)
---
 README.md |  54 ++++++++++++++++++++++++++++++++++++++----------------
 logo.png  | Bin 0 -> 9610 bytes
 2 files changed, 38 insertions(+), 16 deletions(-)

diff --git a/README.md b/README.md
index 156bb45..7cd9b53 100644
--- a/README.md
+++ b/README.md
@@ -1,39 +1,61 @@
-# Emacs major mode for the julia programming language
+# julia-mode
+
+![julia-emacs julia-mode logo](logo.png)
 
-[![Build 
Status](https://travis-ci.org/JuliaEditorSupport/julia-emacs.svg?branch=master)](https://travis-ci.org/JuliaEditorSupport/julia-emacs)
 
[![MELPA](https://melpa.org/packages/julia-mode-badge.svg)](https://melpa.org/#/julia-mode)
+[![Build 
Status](https://travis-ci.org/JuliaEditorSupport/julia-emacs.svg?branch=master)](https://travis-ci.org/JuliaEditorSupport/julia-emacs)
+
+[Emacs](https://www.gnu.org/software/emacs/) major mode for [the Julia 
programming language](https://julialang.org/).
 
-# Installation
 
-## Installing from MELPA
+## Installation
+
+### Installing from MELPA
 
 Unless you want to develop this package, it is recommended that you use it 
from MELPA:
 
-1. [Enable the MELPA repository](https://melpa.org/#/getting-started).
+1. Enable [the MELPA repository](https://melpa.org/#/getting-started).
 
-2. Add `(package-install 'julia-mode)` to your Emacs init file.
+2. Enable the package by adding these lines to to your Emacs init file, e.g., 
`~/.emacs`:
 
-3. Add `(require 'julia-mode)` to your Emacs init file.
+```elisp
+(package-install 'julia-mode)
+(require 'julia-mode)`
+```
 
-## Using the source repository directly
+### Installing from Source
 
-Clone this repository, then use
+To get the latest version of `julia-mode`, clone this repository and then use:
 
 ```elisp
-(add-to-list 'load-path "path-to-julia-mode")
+(add-to-list 'load-path "<path-to-julia-mode>")
 (require 'julia-mode)
 ```
 
-# Contributing
+## Contributing
 
 Contributions are welcome, in the form of pull requests.
 
-Please
+We do our best to provide feedback within 2 weeks. Feel free bump the PR 
thread with a comment after that.
+
 
-1. add unit tests whenever possible. This may require that functions are 
broken up into an interface and a backend function, then you can test the 
backend one.
+### Submitting Pull Requests
 
-2. add a short summary in the [Unreleased section of the 
CHANGELOG](CHANGELOG.md#unreleased).
+- Do add unit tests whenever possible. Consider breaking functions into an 
interface and a backend function for convenient testing.
 
-3. use the `rx` macro (S-expressions) whenever rewriting existing regular 
expressions or introducing new ones; it keeps the code much more readable.
+- Do add a short summary in the *Unreleased* section of the 
[CHANGELOG](CHANGELOG.md#unreleased).
 
-We do our best to provide feedback within 2 weeks, feel free to bump in a 
comment after that.
+- Do use the `rx` macro (S-expressions) whenever rewriting regular expressions 
or introducing new ones. This keeps the code much more readable.
+
+
+### Working With Tests
+
+It's easy to add new 
[ERT](https://www.gnu.org/software/emacs/manual/html_node/ert/index.html) tests 
to the `julia-mode` test suite.
+
+You only need to prepare a new `ert-deftest` definition in 
`julia-mode-tests.el`.
+
+You can run the test suite from the command line with:
+
+```
+emacs -batch -L . -l ert -l julia-mode-tests.el -f  
ert-run-tests-batch-and-exit
+```
diff --git a/logo.png b/logo.png
new file mode 100644
index 0000000..f2b0059
Binary files /dev/null and b/logo.png differ