Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ollydev committed Sep 6, 2023
1 parent 6e3d6a0 commit e0f805a
Show file tree
Hide file tree
Showing 7 changed files with 19 additions and 8 deletions.
Binary file removed Images/docs/simba_windows.png
Binary file not shown.
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added Images/readme/simba_ide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions PACKAGES.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ example=example2.simba
- `example` Will add a script to the "Open Example" window which is opened via the file menu.
- `script` Will add a script to the menu bar.

![Package menu](Images/docs/package_menu.png)
![Package menu](Images/readme/package_menu.png)
*(package menu)*

![Package open example](Images/docs/package_openexample.png)
![Package open example](Images/readme/package_openexample.png)
*(package example)*

----
Expand Down
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,34 +5,45 @@ Simba is a program used to repeat certain (complicated) tasks. Typically these t

The scripting language used is [Lape](https://github.com/nielsAD/lape) which uses a Pascal-like syntax.

Documentation for Simba is available [here](https://villavu.github.io/Simba/index.html).

------

Simba is available for:
- Windows (32 & 64 bit)
- Linux (64 bit & AArch64)
- MacOS (64 bit & AArch64)
- Linux (64 bit & AArch64) - *Requires usage of X11*
- MacOS (64 bit & M1/M2) - *Untested*

![Simba on Windows 11](Images/docs/simba_windows.png)
![Simba on Windows 11](Images/readme/simba_ide.png)

Some dependencies are required for both building and running on Linux/MacOS.

Linux:
- `Xtst` `sudo apt-get install libxtst-dev`
- `gtk2` `sudo apt-get install gtk2.0 libgtk2.0-dev`
- `libffi` `sudo apt-get install libffi-dev`
- `openssl` `sudo apt-get install openssl`
- `openssl` `sudo apt-get install openssl` (for https requests)

MacOS:
- `libffi` `brew install libffi`

------
## Building Simba

Simba is a [Lazarus](https://www.lazarus-ide.org/) project. Lazarus is available here: https://sourceforge.net/projects/lazarus/files/ the latest version should work.
Simba is written in Pascal with [Lazarus](https://www.lazarus-ide.org/) project. Lazarus is available here: https://sourceforge.net/projects/lazarus/files/ the latest version should work.

Steps:
1) Clone the Simba repository & install submodules `git clone --recurse-submodules https://github.com/Villavu/Simba`.
2) Open `Source/Simba.lpi` in Lazarus.
3) Select the build mode required.

![Build Mode](Images/docs/buildmode.png)
![Build Mode](Images/readme/buildmode.png)

4) Build Simba (Run > Build) and when completed the Simba executable will be located in the root directory of the repository.

-----
## Why Pascal?

- Simba dates back to ~2004. Orginally SCAR, then SCAR Divi, then open source clone named Simba.
- Simba has always been a hobby project and keeping its roots in pascal is enjoyable to some!
- Pascal is readable, type-safe, cross-platform and fast.

0 comments on commit e0f805a

Please sign in to comment.