-
-
Notifications
You must be signed in to change notification settings - Fork 2
improve README formatting and clarity #142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 Langagues for Analysis | ||
|
|
||
| [](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 | ||
| ``` | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.