Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README Rework #47

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions Documentation/Install.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

# Installation

<br>

## WGet

*You can install it using  `wget` .*

```sh
wget https://ferret-lang.org/builds/ferret.jar
```

<br>
43 changes: 43 additions & 0 deletions Documentation/Usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

# Usage

<br>

### Example

A program that sums the first 5 positive numbers.

```clojure
;;; lazy-sum.clj

(defn positive-numbers
([]
(positive-numbers 1))
([n]
(cons n (lazy-seq (positive-numbers (inc n))))))

(println (->> (positive-numbers)
(take 5)
(apply +)))
```

<br>

### Compile

Build the binary using:

```shell
java \
-jar ferret.jar \
-i lazy-sum.clj
```

```shell
g++ \
-std=c++11 \
-pthread lazy-sum.cpp \
./a.out
```

<br>
130 changes: 71 additions & 59 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,61 +1,73 @@

<br>

<div align = center>

[![Badge License]][License]   
[![Badge Version]][Website]   
[![Badge Build]][Travis]

<br>
<br>

# Ferret

[![Current Release][badge-ferret-version]][ferret-downloads]
[![CI Build Status][badge-ferret-build]][ferret-travis]
![BSD 2 Clause License][badge-ferret-license]

Ferret is a free software lisp implementation designed to be used in
real time embedded control systems. Ferret lisp compiles down to self
contained *C++11*. Generated code is portable between any Operating
System and/or Microcontroller that supports a *C++11* compliant
compiler. It has been verified to run on architectures ranging from
embedded systems with as little as *2KB of RAM* to general purpose
computers running Linux/Mac OS X/Windows.

This repository contains the Ferret compiler. For more information about Ferret,
including downloads and documentation for the latest release, check
out [Ferret's website](https://ferret-lang.org)

## General Information

- Website - https://ferret-lang.org
- Source Code - https://github.com/nakkaya/ferret
- Mailing List - https://groups.google.com/forum/#!forum/ferret-lang
- Issue Tracker - https://github.com/nakkaya/ferret/issues

## Quick Start

Download latest Ferret release,

```bash
wget https://ferret-lang.org/builds/ferret.jar
```

A program that sums the first 5 positive numbers.

```clojure
;;; lazy-sum.clj
(defn positive-numbers
([]
(positive-numbers 1))
([n]
(cons n (lazy-seq (positive-numbers (inc n))))))

(println (->> (positive-numbers)
(take 5)
(apply +)))
```

Compile to binary using,

```bash
$ java -jar ferret.jar -i lazy-sum.clj
$ g++ -std=c++11 -pthread lazy-sum.cpp
$ ./a.out
```

[ferret-travis]: https://travis-ci.org/nakkaya/ferret/builds
[ferret-downloads]: https://ferret-lang.org
[badge-ferret-version]: https://badge.fury.io/gh/nakkaya%2Fferret.svg
[badge-ferret-build]: https://travis-ci.org/nakkaya/ferret.svg?branch=master
[badge-ferret-license]: https://img.shields.io/badge/License-BSD%202--Clause-orange.svg
A free **Lisp** compiler designed for <br>
***Embedded    Real - Time    Systems*** .

<br>
<br>


[![Button Website]][Website]   
[![Button Install]][Install]   
[![Button Usage]][Usage]   
[![Button Mail]][Mail]

<br>
<br>

Ferret **Lisp** compiles down to self contained  `C++11`  which is <br>
portable between any **OS** / **Micro-controller** that supports it.

<br>

It verifiably can run on embedded systems with as little as <br>
`2KB`  of **RAM** as well as on general purpose computers with <br>
**Linux** / **Mac OS X** / **Windows** installed.

<br>
<br>

*For more information regarding Ferret, including* <br>
*downloads & documentation, check our* ***[Website]*** *.*

</div>

<br>


<!----------------------------------------------------------------------------->

[Website]: https://ferret-lang.org
[Travis]: https://travis-ci.org/nakkaya/ferret/builds 'CI Build Status'
[Mail]: https://groups.google.com/forum/#!forum/ferret-lang

[Install]: Documentation/Install.md
[License]: LICENSE
[Usage]: Documentation/Usage.md


<!----------------------------------[ Badges ]--------------------------------->

[Badge License]: https://img.shields.io/badge/License-BSD_2C-7c1f1d?style=for-the-badge&labelColor=AB2B28
[Badge Version]: https://img.shields.io/github/v/tag/nakkaya/ferret?style=for-the-badge&labelColor=569A31&color=407225&label=Version
[Badge Build]: https://img.shields.io/travis/nakkaya/ferret?style=for-the-badge&labelColor=EF2D5E&color=b11f44


<!---------------------------------[ Buttons ]--------------------------------->

[Button Website]: https://img.shields.io/badge/Website-f57b22?style=for-the-badge&logoColor=white&logo=AWSLambda
[Button Install]: https://img.shields.io/badge/Install-569A31?style=for-the-badge&logoColor=white&logo=DocuSign
[Button Usage]: https://img.shields.io/badge/Usage-3B82F6?style=for-the-badge&logoColor=white&logo=GitBook
[Button Mail]: https://img.shields.io/badge/Mailing_List-EF2D5E?style=for-the-badge&logoColor=white&logo=GMail