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

correct typos #318

Merged
merged 2 commits into from
Apr 14, 2018
Merged
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
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Elchemy lets you write simple, fast and quality type safe code while leveraging
- **Beautiful and fully readable output** - The produced code is idiomatic, performant and can be easily read and analyzed without taking a single look at the original source.

# Patch notes
Since version 0.4 all of the patch notes are included in the description of [a release](https://github.com/wende/elchemy/releases):
Since version 0.4 all the patch notes are included in the description of [a release](https://github.com/wende/elchemy/releases):



Expand Down Expand Up @@ -61,9 +61,9 @@ And follow the instructions

`elchemy` will find all `*.elm` files specified in `elchemy_path` and compile it into corresponding `*.ex` files in `lib` directory.

You can override output directory specifing `elixirc_paths`.
You can override output directory specifying `elixirc_paths`.

### Instalation as a standalone
### Installation as a standalone
```shell
npm install -g elchemy
```
Expand Down Expand Up @@ -93,7 +93,7 @@ To launch and test the web demo

## Targeted values:
- Fully readable and indented elixir code generated from compilation
- Seamless and stressless interop with existing Elixir code, preferably with magically working type safety
- Seamless and stress less interop with existing Elixir code, preferably with magically working type safety
- Full integration with entire elm syntax for editors and compilers magic

## Troubleshooting
Expand Down Expand Up @@ -133,17 +133,17 @@ Definitely. Yes. Please do.
## How are types represented?
You're a nosy one, aren't you?
Elchemy represents all type constructors as snake cased atoms, and all type applications as tuples.
Which means that `MyType 42 "Fourty two" Error` in Elchemy equals to `{:my_type, 42, "Fourty Two", :error}` in Elixir.
Which means that `MyType 42 "Forty two" Error` in Elchemy equals to `{:my_type, 42, "Forty Two", :error}` in Elixir.

## Can I use already existing Elm libraries with Elchemy?
As long as they don't use any Native modules, Ports or Elm runtime they can be safely imported and used

## Can I use already existing Elixir libraries with Elchemy?
Yes. You can do an `ffi` call to any function in any module. Whether it's Elixir module, Erlang module, or even a macro you can include it in your code. Ffi calls are a treated specially in Elchemy and they get generated test to analyze the types based on @specs, so that you don't compromise type safety for using Elixir code.
In order to increase readbility it's advised no to use `ffi` calls if not necessary and always document and doctest them.
Yes. You can do an `ffi` call to any function in any module. Whether it's Elixir module, Erlang module, or even a macro you can include it in your code. Ffi calls are a treated specially in Elchemy, and they get generated test to analyze the types based on @specs, so that you don't compromise type safety for using Elixir code.
In order to increase readability it's advised not to use `ffi` calls if not necessary and always document and doctest them.

## But what about out of function macros? Like tests and `use Module`?
Unfortunatelly you can't write any macros with `do..end` blocks yet. You can write any out of function code using an elixir inline code with:
Unfortunately you can't write any macros with `do..end` blocks yet. You can write any out of function code using an elixir inline code with:
```elm
{- ex
code_here
Expand All @@ -155,7 +155,7 @@ But it's a last resort solution and shouldn't ever be abused.
So you want to write an Elm-like code, that will manipulate Elixir code, which generates an Elixir code that manipulates Elixir code? How about no?

## Do I need to have Elm installed to compile my `.elm` files with Elchemy?
Elchemy uses Elm to typecheck your program. Although it is possible to use it without Elm on your machine it's not advised.
Elchemy uses Elm to typecheck your program. It is possible to use it without Elm on your machine, while it's not advised.


# Maturity of the project
Expand Down