Skip to content

Commit ba12569

Browse files
committed
add more docs
1 parent 22bda46 commit ba12569

File tree

3 files changed

+69
-4
lines changed

3 files changed

+69
-4
lines changed

Diff for: CONTRIBUTING

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Quick Installation Guide for musl libc
2+
======================================
3+
4+
5+
Contributions are very welcome, currently we do not have any explicit
6+
guidelines.
7+
8+
9+
Acknowledgements
10+
----------------
11+
12+
The vast majority of the code in another-elm is derived from the relavant elm/*
13+
packages.
14+
15+
The documentation of another-elm is inspired by that of [musl].
16+
17+
[musl]: https://musl.libc.org/

Diff for: INSTALL

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Quick Installation Guide for musl libc
2+
======================================
3+
4+
5+
another-elm comes with a wrapper script of the same name. The wrapper should be
6+
a drop in replacement for the offical elm compiler.
7+
8+
9+
Prerequisites
10+
-------------
11+
12+
The wrapper script is written in python, a non-eol needs to be installed to run
13+
the wrapper. The official elm compiler must also be installed.
14+
15+
16+
Supported Elm Versions
17+
----------------------
18+
19+
We support the latest version of elm, older versions may be supported but that
20+
support may be removed at any time.
21+
22+
23+
Build and Installation Procedure
24+
--------------------------------
25+
26+
To build and install another-elm:
27+
28+
sudo mkdir -p /opt/elm/
29+
sudo chown $USER /opt/elm
30+
git clone https://github.com/another-elm/std /opt/elm/std
31+
sudo ln -s /opt/elm/std/tools/another-elm /usr/local/bin/another-elm
32+
33+
34+
Checking for Successful Installation
35+
------------------------------------
36+
37+
Currently it is hard to work out if the installation worked correctly. In the
38+
future we will automate this. For now, here is a usefull test: if the compiler
39+
generates javascript contains "$elm$core$Platform$Raw$Scheduler" then
40+
another-elm has been correctly installed.

Diff for: README

+12-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
another-elm/core
21

3-
Another implementation of the elm core library.
2+
another-elm/std
3+
4+
Another implementation of the elm standard libraries. Contributions are very
5+
welcome, currently we are aiming for maximum compatibility with the offical
6+
elm/* packages.
7+
8+
See
9+
10+
./NEWS: To read about the development of this library
11+
./LICENSE: For the BSD-3-Clause licence.
12+
./INSTALL: For installation details.
13+
./CONTRIBUTING: To get involved and for our acknowledgements.
414

5-
To read about the development of this library see ./NEWS which hopefully
6-
chronicles the most important developments.
715

816
We will leave you with Tom Odell's `Another elm':
917

0 commit comments

Comments
 (0)