Tissevert
/
SJW
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Release v0.1.0

This commit is contained in:
Tissevert 2020-01-01 20:01:17 +01:00
parent 358ef75773
commit 9bc9b728b7
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -1,5 +1,5 @@
# Revision history for SJW
## 0.1.0.0 -- YYYY-mm-dd
## 0.1.0.0 -- 2020-01-01
* First version. Released on an unsuspecting world.
* First working version with a small example

22
README.md
View File

@ -1,3 +1,25 @@
# SJW
The Simple Javascript Wrench is a tool made to compile a set of independant Javascript modules into a single executable javascript file as expected by a webbrowser. It allows you to write (relatively) clean Javascript and to package it into one single script that will run once the page loading it is loaded.
## How to install
SJW can be compiled and installed from a version of this repository by issueing the following commands
```
$ cabal new-update
$ cabal new-build
$ cabal new-install sjw
```
## Using it
SJW is a sort of compiler that expects the path to a source directory as argument and will output (on `stdout` or at the path given with the usual `-o` option) a script containing all the code required by the `Main` module.
The `demo/` directory is a simple example of this mechanism (I even committed the output `main.js` by accident but it's actually useful because you can try and generate it locally and check that you get exactly the same result). Run the following from this directory (if you're not used to haskell projects handled with cabal, make sure you have `~/.cabal/bin` in your `$PATH` variable) :
```
$ sjw demo/src -o demo/main.js
```
Ask `sjw --help` to read more about available options or to print the version of SJW you're using.