Skip to content

Commit

Permalink
readme: add more instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
takase1121 committed May 11, 2024
1 parent 53f0be6 commit 88502dd
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,26 @@ Lite XL includes a shell file that does the job pretty well,
but the aim here is to improve the experience more by making it actually
useful.

You will need to use Emscripten 3.1.57. Older versions may not work.
## Instructions

This repository is still a work-in-progress, so detailed instructions on how
to set up everything is not available.

In general, you will need the following tools:

- Emscripten (optionally emsdk) 3.1.57 and newer. Older versions will not work.
- wasm-dis (Installed with Emscripten if emsdk is used)
- file_packager (Installed with Emscripten if emsdk is used)
- watchexec (Optional)
- A HTTP Server (I use `http-server`, but Python's `http.server` will work with caveats.)
- Git
- Bash (MSYS2 might work but not tested)
- npm (Optional, for prettifying source code)

Your entry point will be `build.sh`, which can be used to build and deploy the application.
For most people, running `./build.sh` will be sufficient,
or you could run `./build.sh -w` to automatically build the project when a file is changed.

The generated file are available in `dist`.

You can find specific documentation in each subfolder.

0 comments on commit 88502dd

Please sign in to comment.