File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -54,10 +54,43 @@ You can **visit our page on the pypi registry**: https://pypi.org/project/spicec
5454
5555
5656### For Development
57- i will write a better tutorial later but for now basically just:
58- - clone the repo yeah no shit
59- - create a python virtual enviroment with venv
60- - install the requirements.txt with ``` pip install -r requirements.txt ``` (not sure about this one but probably works)
61- - install the package locally with ``` pip install -e . ```
62- - then run it using ``` spice analyze ``` followed by the file to be analyzed
63- - example: ``` spice analyze example.js ```
57+ - Clone the repo to your machine
58+ - Go to the cloned spicecode folder
59+ - Create a python virtual environment (venv):
60+ ```
61+ python -m venv venv
62+ ```
63+
64+ - Activate your virtual environment:
65+ - ** Windows**
66+ ```
67+ ./venv/Scripts/activate
68+ ```
69+ - ** Linux**
70+ ```
71+ source ./venv/bin/activate
72+ ```
73+
74+ - Install all packages from requirements.txt:
75+ ```
76+ pip install -r requirements.txt
77+ ```
78+
79+ - Install (build) the spicecode package locally:
80+ ```
81+ pip install -e .
82+ ```
83+
84+ - Have fun!
85+ ```
86+ spice version
87+ ```
88+ ```
89+ spice hello
90+ ```
91+ ```
92+ spice translate
93+ ```
94+ ```
95+ spice analyze
96+ ```
You can’t perform that action at this time.
0 commit comments