diff options
Diffstat (limited to 'code/overview.rst')
| -rw-r--r-- | code/overview.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/code/overview.rst b/code/overview.rst new file mode 100644 index 00000000..9bb16d84 --- /dev/null +++ b/code/overview.rst @@ -0,0 +1,58 @@ +Overview +============== + +Welcome to eSim! +---------------- + +**eSim** is an **open-source** Electronic Design Automation (EDA) tool developed by **FOSSEE, IIT Bombay**, with the goal of making circuit design and simulation accessible to students, educators, and professionals across the globe. + +This documentation is designed for both users who want to design and simulate circuits with eSim, and for developers interested in contributing to the eSim codebase. + +About the Documentation +------------------------------ +The documentation is divided into two main sections: + +1. **Getting Started:** + Learn how to install eSim and get up and running quickly. This section covers the introduction to eSim and the installation guide. + +2. **Components:** + Dive deep into the eSim codebase. This section explains each module, file, and method, helping developers and advanced users understand and extend eSim. + +Open-Source Software Used by eSim +------------------------------------ +eSim was developed using many open-source tools, some of them are: + +* `Python <https://www.python.org/>`_ +* `KiCad <https://www.kicad.org/>`_ +* `NGHDL <https://github.com/fossee/nghdl/>`_ +* `Makerchip <https://www.makerchip.com/>`_ +* `SkyWater SKY130 PDK <https://skywater-pdk.rtfd.io/>`_ + +Useful Links +------------------------------ + +**eSim Manual** +To know everything about eSim, how it works, and its features, please download the manual from +`eSim Manual <https://static.fossee.in/esim/manuals/eSim_Manual_2.5.pdf>`_ + +**Contact** +For any queries regarding eSim, please write to us at +`contact-esim@fossee.in <mailto:contact-esim@fossee.in>`_ + +**Contribution** +Please refer to the `contribution guidelines <https://github.com/FOSSEE/eSim/blob/master/CONTRIBUTION.md>`_ for further details. + +**License** +eSim is developed by the FOSSEE Team at IIT Bombay and is released under the GNU GPL License. + +- **Source Code of eSim:** + `https://github.com/FOSSEE/eSim <https://github.com/FOSSEE/eSim>`_ + +- **Official Website of FOSSEE:** + `https://fossee.in/ <https://fossee.in/>`_ + +- **eSim Resources:** + `https://esim.fossee.in/resources <https://esim.fossee.in/resources>`_ + +- **Community Forum:** + `https://esim.fossee.in/forum <https://esim.fossee.in/forum>`_ |