Skip to content

Commit

Permalink
Finish docs and alpha reflect
Browse files Browse the repository at this point in the history
  • Loading branch information
erp12 committed Sep 13, 2021
1 parent c92ad02 commit 7a374bc
Show file tree
Hide file tree
Showing 8 changed files with 420 additions and 63 deletions.
22 changes: 10 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,20 @@
Clojure is a great language, but some people use Scala... and that's okay!

Fijit is a Clojure library for interop with Scala. The goal of this project is to make it easier and more idiomatic to
use Scala projects from within your Clojure projects.
use Scala projects from within your Clojure projects. Some key features include:

- Conversions between Scala and Clojure collection types.
- Macros for writing Clojure code that targets multiple Scala versions.
- A Clojure implementation of the Scala function types.
- Idiomatic Clojure wrappers for common Scala types like `Option`, `Try`, `Tuple`, and more.
- An experimental Clojure API for Scala reflection and compilation.

## Documentation

Please see the [official documentation page](erp12.github.io/fijit/index.html) for more information on installation, usage, the API, and more.
Please see the [official documentation page](erp12.github.io/fijit/index.html) for more information on
installation, usage, the API, and more.

Quick Links:
- [Guide and Overview](erp12.github.io/fijit/guide.html)
- [API](erp12.github.io/fijit/index.html)
- [Contributing](erp12.github.io/_fijit_/contributing.html)

# Todo before first release

- Write documentation guides.
- How to add to deps.
- Native interop
- Calling object methods.
- Calling package object methods.
- Touching path dependent types.
- [Contributing](erp12.github.io/fijit/contributing.html)
16 changes: 10 additions & 6 deletions doc_src/faq.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,27 @@
# Frequently Asked Questions

## Will Fijit ever support Scala 3?
## Will fijit ever support Scala 3?

The short answer is: probably not.

The original motivation for building Fijit was to facilitate the development of Clojure interfaces into Scala-native
The original motivation for building fijit was to facilitate the development of Clojure interfaces into Scala-native
projects like [Apache Spark](https://spark.apache.org/) and [Akka](https://akka.io/).
At the time of writing, neither of these tools run on Scala 3 and will likely not be switching for a long time.

That said, Fijit already leverages macros to delegate to different implementations depending on the Scala version.
It is possible that a Scala 3 implementation is possible for the entire Fijit API, it is possible that one day Fijit
That said, fijit already leverages macros to delegate to different implementations depending on the Scala version.
It is possible that a Scala 3 implementation is possible for the entire fijit API, it is possible that one day fijit
could support Scala 3.

If you are inclinded to help with this effort, please see the [contributing guide](erp12.github.io/fijit/contributing.html).
If you are inclined to help with this effort, please see the [contributing guide](erp12.github.io/fijit/contributing.html).

## Why the name "Fijit"?
## Why the name "fijit"?

Clojure and Scala are both:

- **F**unctional.
- **I**mmutable-first.
- **J**vm hosted (primarily).

## How to pronounce "fijit"?

Same as "fidget".
Loading

0 comments on commit 7a374bc

Please sign in to comment.