Skip to content

Commit 643e48f

Browse files
authored
Merge pull request #10 from levno-710/develop
2 parents 92c7915 + 6c38c41 commit 643e48f

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

readme.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,37 @@ git clone https://github.com/Levno710/Prometheus.git
1717
Alternatively you can download the Sources [here](https://github.com/Levno710/Prometheus/archive/refs/heads/master.zip).
1818

1919
Prometheus also Requires LuaJIT or Lua51 in order to work. The Lua51 binaries can be downloaded [here](https://sourceforge.net/projects/luabinaries/files/5.1.5/Tools%20Executables/).
20+
21+
On Windows the windows release can also be used, which includes everything needed to run the prometheus cli.
2022
## Usage
2123
Prometheus provides a simple cli for obfuscating scripts. It can be used as following:
2224
```batch
2325
lua ./cli.lua [options] ./your_file.lua
2426
```
27+
When using the windows release:
28+
```batch
29+
prometheus.exe [options] ./your_file.lua
30+
```
2531
## Tests
2632
To perform the Prometheus Tests, just run
2733
```batch
2834
lua ./tests.lua
2935
```
36+
## Building
37+
Prometheus can currently only be build for and on Windows.
38+
It requires [srlua.exe](https://github.com/LuaDist/srlua) and [glue.exe](https://github.com/LuaDist/srlua) inside of the root directory. If lua51 was linked dynamically, lua51.dll must also be present. Then Prometheus for Windows can be built using
39+
```batch
40+
build.bat
41+
```
42+
This creates a folder named build, that contains prometheus.exe as well as everything that is needed in order to run Prometheus.
43+
Then
44+
```batch
45+
prometheus.exe [options]
46+
```
47+
can be used instead of
48+
```batch
49+
lua ./cli.lua [options]
50+
```
3051
## Credits
3152
### Contributors
3253
- [levno-710](https://github.com/levno-710)

0 commit comments

Comments
 (0)