Skip to content

Commit

Permalink
improving readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gbaptista committed Aug 16, 2020
1 parent ae4bc74 commit aa04f30
Showing 1 changed file with 91 additions and 0 deletions.
91 changes: 91 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,92 @@
# Fennel Support for Sublime Text 3

> _Fennel is a programming language that brings together the speed, simplicity, and reach of Lua with the flexibility of a lisp syntax and macro system. [fennel-lang.org](https://fennel-lang.org)_
Heavily tested against [Fennel 0.5.0](https://github.com/gbaptista/sublime-3-fennel/blob/master/tests/syntax_test_fennel_reference.fnl) and [Lua 5.4.0](https://github.com/gbaptista/sublime-3-fennel/blob/master/tests/syntax_test_lua.fnl) specifications.

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/material-theme-darker/03.png)

- [Completions](#completions)
- [Fennel](#fennel-completions)
- [Lua](#lua-completions)
- [Snippets](#snippets)
- [Acknowledgments](#acknowledgments)
- [References](#references)
- [Screenshots](#screenshots)
- [Material Theme Darker](#material-theme-darker-screenshots)
- [Monokai](#monokai-screenshots)
- [Solarized (Light)](#solarized-light-screenshots)
- [Completions](#completions-screenshots)
- [Snippets](#snippets-screenshots)

## Completions

One hundred ninety-four completions are available for _Fennel 0.5.0_ and _Lua 5.4.0_.

#### Fennel Completions

![Screenshot of a Fennel code with a completions list.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/completions/03.png)

#### Lua Completions

![Screenshot of a Fennel code with a completions list.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/completions/01.png)

## Snippets

14 snippets are available:

- `fn` `lambda` `λ`
- `and` `or` `not`
- `->` `->>` `-?>` `-?>>`
- `while` `do` `if` `do while`

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/snippets/01.png)

## Acknowledgments

This package used the [_Clojure Package_](https://github.com/sublimehq/Packages/tree/master/Clojure) as an initial reference.

## References
- [Fennel Language Website](https://fennel-lang.org)
- [Fennel 0.5.0 Reference](https://fennel-lang.org/reference)
- [Lua Language Website](http://www.lua.org/)
- [Lua 5.4 Reference Manual](https://www.lua.org/manual/5.4)
## Screenshots

### Material Theme Darker Screenshots

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/material-theme-darker/01.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/material-theme-darker/02.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/material-theme-darker/03.png)

### Monokai Screenshots

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/monokai/01.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/monokai/02.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/monokai/03.png)

### Solarized (Light) Screenshots

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/solarized-light/01.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/solarized-light/02.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/solarized-light/03.png)

### Completions Screenshots

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/completions/01.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/completions/02.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/completions/03.png)

### Snippets Screenshots

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/snippets/01.png)

![Screenshot of a Fennel code highlighted.](https://raw.githubusercontent.com/gbaptista/sublime-3-fennel/master/screenshots/snippets/02.png)

0 comments on commit aa04f30

Please sign in to comment.