aboutsummaryrefslogtreecommitdiff
path: root/readme.html
blob: 7f7336766ea5bc951b98f4224e3d30fb9a425f0d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<h1>Network Simulator</h1>
<p>This project will attemt to simulate networks, from Connections to simple applictations</p>
<p>It is planned to have a core written in C and have devices, connections and protocols defined through extensions defined in a json file with "kernels" for the devices written in LUA.</p>
<h2>Status of the project</h2>
<p>A few things work now, most things don't. I'll add more things soon!</p>
<p>Some code in this project is VERY dirty. I'm not a professional developer, do not expect great quality! Any suggestions and pull requests that will improve this are, of course, always welcome!</p>
<h2>What this project will not do</h2>
<p>Unlike GNS3 this project will not attempt to emulate existing devices or allow connecting to physical devices, instead this project will have all devices written in LUA</p>
<h2>Building</h2>
<p>To build this project you'll need the following:</p>
<ul>
<li>emacs with ede (releases will contain a Makefile)</li>
<li>A C compiler</li>
<li>GTK 4.12 and its dependecies</li>
<li>lua 5.4</li>
<li>json-c</li>
<li>pkg-config</li>
<p>You can now open the project in emacs and compile it with <code>ede-compile-project</code> and run it with <code>./netsim -t templates</code></p>
</ul>
<h2>Screenshot</h2>
<img alt="Example screenshot" src="/img/netsim_rm.png" style="max-width: 100%; max-height: 450px;"/>
<h2>License</h2>
<p>All the files in this repository are licensed under the GPLv3, you can find it in the LICENSE file or on the <a href=https://www.gnu.org/licenses/gpl-3.0.en.html>GNU Website</a></p>
Jeremias Stotters git repositories generated by CGIT