Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/SalamLang/Salam
Browse files Browse the repository at this point in the history
  • Loading branch information
BaseMax committed Nov 30, 2024
2 parents e150d99 + c4f75e5 commit e9fad1d
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 15 deletions.
58 changes: 43 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,33 +51,51 @@ Salam is the first Persian/Iranian computer scripting language.

### Usage Examples

- **Execute a Script**:
- **Execute a Script**:

```bash
./salam <filename>
```

- **Compile and Run Code**:
- **Compile and Run Code**:

```bash
./salam code <content> <output_dir>
```

- **Lint Scripts**:
- **Lint Scripts**:

```bash
./salam lint <filename> <output_dir>
```

- **Version Check**:
- **Version Check**:

```bash
./salam version
```

- **Update Salam**:
- **Update Salam**:

```bash
./salam update
```

For a detailed guide, visit our official site: [salamlang.ir](https://salamlang.ir)

## Control Panel

```bash
cd config/admin
pip install -r requirements.txt
python app.py
or
python3 app.py
```

![Salam Programming Language Panel](assets/panel.jpg)

## 🐳 Using Salam with Docker

Run Salam in an isolated and consistent Docker environment.
Expand All @@ -100,52 +118,62 @@ docker run --rm -it basemax/salam

#### Build Locally (Optional)

1. Clone the Salam repository:
1. Clone the Salam repository:

```bash
git clone https://github.com/SalamLang/Salam
cd Salam
```

2. Build the Docker image:
3. Build the Docker image:

```bash
docker build -f docker/Dockerfile -t salam .
```

3. Verify the image:
4. Verify the image:

```bash
docker images salam
```

### Running Scripts

#### Mount a Local Script

```bash
docker run --rm -it -v $(pwd):/scripts salam ./salam /scripts/your_script.salam
```

#### Inline Code Execution

```bash
docker run --rm -it salam ./salam code "صفحه: محتوا = «سلام دنیا از سلام» تمام"
```

### Explore Salam Commands

- **Check Version**:
- **Check Version**:

```bash
docker run --rm -it salam ./salam version
```

- **Update Salam**:
- **Update Salam**:

```bash
docker run --rm -it salam ./salam update
```

- **Lint Scripts**:
Lint a File:
- **Lint Scripts**:

Lint a File:

```bash
docker run --rm -it -v $(pwd):/scripts salam ./salam lint /scripts/your_script.salam /output
```
Lint Inline Code:
Lint Inline Code:

```bash
docker run --rm -it salam ./salam lint code "some salam code"
```
Expand All @@ -157,6 +185,6 @@ We welcome contributions from the community!
- 🌟 Follow our [Code of Conduct](CODE_OF_CONDUCT.md).

Together, let’s make coding accessible to all.
For inquiries or feedback, visit: [salamlang.ir](https://salamlang.ir)

© 2024 Salam Language Team
For inquiries or feedback, visit: [salamlang.ir](https://salamlang.ir)
© 2024 Salam Language Team
Binary file added assets/panel.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e9fad1d

Please sign in to comment.