summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGloria12102020-06-13 01:01:02 +0530
committerGitHub2020-06-13 01:01:02 +0530
commit9ec19f625a25442bc17ed1c02ea12989bbc63d87 (patch)
tree26fe356af54a2d86c7253dcb62088dcafc740cc1
parentf78ea4fa13c4c97b243e795cbcadb53d116f7cca (diff)
downloadeSim_PSpice_to_KiCad_Python_Parser-9ec19f625a25442bc17ed1c02ea12989bbc63d87.tar.gz
eSim_PSpice_to_KiCad_Python_Parser-9ec19f625a25442bc17ed1c02ea12989bbc63d87.tar.bz2
eSim_PSpice_to_KiCad_Python_Parser-9ec19f625a25442bc17ed1c02ea12989bbc63d87.zip
Update README.md
-rw-r--r--README.md23
1 files changed, 13 insertions, 10 deletions
diff --git a/README.md b/README.md
index 0738580..7577b96 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,27 @@
-eSim_PSpice_to_KiCad_Python_Parser
+# eSim_PSpice_to_KiCad_Python_Parser
+
This code is written by Suryavamsi Tenetti, FOSSEE, IIT Bombay and modified by Sumanto Kar and Gloria Nandihal, FOSSEE, IIT Bombay.
+
This program converts PSpice schematic files (.sch) to KiCad schematic files (.sch)
+
This program converts PSpice library files (.slb) to KiCad library files (.lib)
USAGE:
-----------------------------------------------
-Make sure the python compiler is installed in the PC.
+**Make sure the python 3 compiler is installed in the PC**
Run the following command in the terminal in order to install it.
$ sudo apt install python3.7
-----------------------------------------------
-To download the eSim_PSpice_to_KiCad_Python_Parser
+**To download the eSim_PSpice_to_KiCad_Python_Parser**
Clone or Download the eSim_PSpice_to_KiCad_Python_Parser from the Git in the Home folder(or any other folder) of the local computer.
-----------------------------------------------
-To convert the PSpice library(.slb) files to KiCad library(.lib) files
+**To convert the PSpice library(.slb) files to KiCad library(.lib) files**
Set the path where the libparser.py file is located.
@@ -30,7 +33,7 @@ $ sudo python3 libParser.py ~/Home/eSim_PSpice_to_KiCad_Python_Parser/libray/ana
This will create analog.lib file and save it in the path </Home/eSim_PSpice_to_KiCad_Python_Parser/libray/>
-----------------------------------------------
-To convert the PSpice schematic files to KiCad schematic files
+**To convert the PSpice schematic files to KiCad schematic files**
Set the path where the parser.py file is located.
@@ -43,7 +46,7 @@ This will create a folder rc at the location /Desktop/convert/. The directory wi
The directory will have read only access. You need to use chmod command to change the access.
--------------------------------------------------------
-To change the access of the file and folder
+**To change the access of the file and folder**
Use this command to change access to the files:
@@ -58,7 +61,7 @@ sudo chmod 777 filename.
Example: sudo chmod 777 ~/Desktop/convert/rc
-----------------------------------------------
-To open the KiCad schematic file in eSim
+**To open the KiCad schematic file in eSim**
1. Open eSim.
2. Create a new project.
@@ -70,7 +73,7 @@ To open the KiCad schematic file in eSim
8. To simulate, follow the instructions available on the eSim webpage
https://esim.fossee.in/pspice-to-kicad
-----------------------------------------------
-To load the libraries
+**To load the KiCad libraries**
If all the libraries in eeschema are not loaded, follow these steps:
1. In eeschema, select Preferences option.
@@ -80,13 +83,13 @@ If all the libraries in eeschema are not loaded, follow these steps:
5. Select the library to be added and click on Open button.
6. Close the dialog box.
-----------------------------------------------
-To add libraries in the parser.py
+**To add libraries in the parser.py**
Open the parser.py python file in the PythonLib folder.
Type and add the libraries in the variables "descr" and "prodescr"
-----------------------------------------------
-WARNING:
+**WARNING:
1. Filenames should NOT contain whitespaces or tabs.
2. All required libraries SHOULD be added.