Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 36 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,96 +1,106 @@
# 🌶️ SpiceCode CLI - Making your code spicier 🔥🥵

## Installing via PIP

### Installing via PIP
- Make sure you have Python installed on your system
- Open the terminal
- Install SpiceCode via PIP with:
```

```bash
pip install spicecode
```

### Using SpiceCode

- After installing via PIP, you can run these three commands: *(replace file with the filename)*

```
```bash
spice hello
```

```
```bash
spice translate
```

```
```bash
spice analyze FILE
```

- EXAMPLE:
```
- EXAMPLE:

```bash
spice analyze code.js
```


---

### Supported Programming Langagues for Analysis:
### Supported Programming Languages for Analysis

[![My Skills](https://skillicons.dev/icons?i=python,js,ruby,go&perline=10)](https://skillicons.dev)

- Python **(.py)**
- JavaScript **(.js)**
- Ruby **(.rb)**
- Go **(.go)**
- Many more **coming soon!**


#### All lexers and parsers are built by us. We don't use external libraries/packages to parse your code.


#### All lexers and parsers are built by us. We don't use external libraries/packages to parse your code

---

You can **visit our page on the pypi registry**: https://pypi.org/project/spicecode/
You can **visit our page on the pypi registry**: [https://pypi.org/project/spicecode/](https://pypi.org/project/spicecode/)

---


### For Development

- Clone the repo to your machine
- Go to the cloned spicecode folder
- Create a python virtual environment (venv):
```

```bash
python -m venv venv
```

- Activate your virtual environment:

- **Windows**
```

```bash
./venv/Scripts/activate
```

- **Linux**
```

```bash
source ./venv/bin/activate
```

- Install all packages from requirements.txt:
```

```bash
pip install -r requirements.txt
```

- Install (build) the spicecode package locally:
```

```bash
pip install -e .
```

- Have fun!
```

```bash
spice version
```
```

```bash
spice hello
```
```

```bash
spice translate
```
```

```bash
spice analyze
```
```