Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jcubic committed Jan 17, 2024
1 parent 18b39bb commit ee5ecad
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 3 deletions.
20 changes: 18 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
alt="LIPS - Scheme Based Powerful Lisp Language" />
</h1>

[![npm](https://img.shields.io/badge/npm-1.0.0%E2%80%93beta.17-blue.svg)](https://www.npmjs.com/package/@jcubic/lips)
[![npm](https://img.shields.io/badge/npm-1.0.0%E2%80%93beta.17.3-blue.svg)](https://www.npmjs.com/package/@jcubic/lips)
![1.0.0 Complete](https://img.shields.io/github/milestones/progress-percent/jcubic/lips/1?label=1.0.0%20Complete)
[![Build and test](https://github.com/jcubic/lips/actions/workflows/build.yaml/badge.svg?branch=master&event=push)](https://github.com/jcubic/lips/actions/workflows/build.yaml)
[![Coverage Status](https://coveralls.io/repos/github/jcubic/lips/badge.svg?branch=master&1eb2cfbcb9a646f24938a31ec46bbc33)](https://coveralls.io/github/jcubic/lips?branch=master)
Expand Down Expand Up @@ -309,9 +309,25 @@ Links which point to the LIPS website for SEO purpose
- [ ] [KISS](https://github.com/jcubic/kiss) (chrome extension REPL).
- [ ] [SMILE](https://github.com/jcubic/smile) (Web IDE), need to start over.

## How you can help

I'm working on version 1.0. If you find any bugs you can help by reporting them.
If you have some Scheme code that doesn't work (note about the limitations)
don't hesitate to [report an issue](https://github.com/jcubic/lips/issues/new).

You can also propose a feature or improvement to the library, it doesn't always have to be defects.

If you enjoy the library you can write about it in a blog post and share information about it or write on Social Media.
Don't forget to link to the project website (it's
[good for SEO](https://itnext.io/seo-for-open-source-projects-1a6b17ffeb8b)).

Of course, if you want you can also contribute with code, but there are way easier ways to help.

I would also love to see if you use the library, I may even share the links of projects that use it.

## Acknowledgments
* Font used in logo is [Telegrafico](https://www.dafont.com/telegrafico.font) by [ficod](https://www.deviantart.com/ficod).
* Current parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
* Current Parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
* `fetch` polyfill use [unfetch](https://github.com/developit/unfetch) by Jason Miller.
* Browser `init` function use [ContentLoaded](http://javascript.nwbox.com/ContentLoaded/).
* The rationalize algorithm is based on [Kawa Scheme](https://www.gnu.org/software/kawa/index.html) by Per M.A. Bothner, Alan Bawden and Marc Feeley.
Expand Down
18 changes: 17 additions & 1 deletion templates/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,9 +309,25 @@ Links which point to the LIPS website for SEO purpose
- [ ] [KISS](https://github.com/jcubic/kiss) (chrome extension REPL).
- [ ] [SMILE](https://github.com/jcubic/smile) (Web IDE), need to start over.

## How you can help

I'm working on version 1.0. If you find any bugs you can help by reporting them.
If you have some Scheme code that doesn't work (note about the limitations)
don't hesitate to [report an issue](https://github.com/jcubic/lips/issues/new).

You can also propose a feature or improvement to the library, it doesn't always have to be defects.

If you enjoy the library you can write about it in a blog post and share information about it or write on Social Media.
Don't forget to link to the project website (it's
[good for SEO](https://itnext.io/seo-for-open-source-projects-1a6b17ffeb8b)).

Of course, if you want you can also contribute with code, but there are way easier ways to help.

I would also love to see if you use the library, I may even share the links of projects that use it.

## Acknowledgments
* Font used in logo is [Telegrafico](https://www.dafont.com/telegrafico.font) by [ficod](https://www.deviantart.com/ficod).
* Current parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
* Current Parser is inspired by implementation in [BiwaScheme](https://www.biwascheme.org/) by Yutaka HARA (yhara).
* `fetch` polyfill use [unfetch](https://github.com/developit/unfetch) by Jason Miller.
* Browser `init` function use [ContentLoaded](http://javascript.nwbox.com/ContentLoaded/).
* The rationalize algorithm is based on [Kawa Scheme](https://www.gnu.org/software/kawa/index.html) by Per M.A. Bothner, Alan Bawden and Marc Feeley.
Expand Down

0 comments on commit ee5ecad

Please sign in to comment.