From ca6d028f8c9c60c0f46b11af37be12e1dfeff96e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=8Dcaro=20Botelho?= <111321065+icrcode@users.noreply.github.com> Date: Wed, 14 May 2025 20:03:56 -0300 Subject: [PATCH 1/2] improve README formatting and clarity --- README.md | 62 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 36 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 6be7b46..69c7778 100644 --- a/README.md +++ b/README.md @@ -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 Langagues 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 -``` \ No newline at end of file +``` From 1d0a0426c75de1aa498d07026639fdd7d5e19152 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=8Dcaro=20Botelho?= <111321065+icrcode@users.noreply.github.com> Date: Wed, 14 May 2025 20:06:02 -0300 Subject: [PATCH 2/2] Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 69c7778..5ea1fda 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ 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)