-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
136 lines (134 loc) · 6.06 KB
/
Copy pathindex.html
File metadata and controls
136 lines (134 loc) · 6.06 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CogLink: CogLink</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">CogLink<span id="projectnumber"> v3.0.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">CogLink </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_README"></a> A Concord (C99) LavaLink/NodeLink client.</p>
<h1><a class="anchor" id="autotoc_md1"></a>
Features</h1>
<ul>
<li>C99 compatible</li>
<li>Low memory usage (> 5MB of RAM a working bot)</li>
<li>Portable</li>
</ul>
<h1><a class="anchor" id="autotoc_md2"></a>
Dependencies</h1>
<ul>
<li><a href="https://github.com/Cogmasters/Concord"><code>Concord</code></a></li>
</ul>
<blockquote class="doxtable">
<p >‍[!NOTE] CogLink only relies on dependencies already included in Concord. </p>
</blockquote>
<h1><a class="anchor" id="autotoc_md3"></a>
Installation</h1>
<h2><a class="anchor" id="autotoc_md4"></a>
1. Install Concord</h2>
<p >The installation guide for Concord can be found <a href="https://github.com/Cogmasters/concord?tab=readme-ov-file#build-instructions">in their repository</a>.</p>
<h2><a class="anchor" id="autotoc_md5"></a>
2. Clone the repository</h2>
<div class="fragment"><div class="line">$ git clone https://github.com/PerformanC/CogLink</div>
</div><!-- fragment --><h2><a class="anchor" id="autotoc_md6"></a>
3. Compile</h2>
<div class="fragment"><div class="line">$ cd CogLink</div>
<div class="line">$ make -j4</div>
</div><!-- fragment --><blockquote class="doxtable">
<p >‍[!NOTE] The <code>-j4</code> flag is optional, but it will speed up the compilation process. The number after <code>-j</code> is the number of threads to use for compilation. </p>
</blockquote>
<h2><a class="anchor" id="autotoc_md7"></a>
4. Install</h2>
<div class="fragment"><div class="line">$ sudo make install</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md8"></a>
Usage</h1>
<p >... TODO</p>
<h1><a class="anchor" id="autotoc_md9"></a>
Documentation</h1>
<p ><a href="https://performanc.github.io/CoglinDocs/">CogLink documentation</a> is made with Doxygen, hosted on GitHub Pages.</p>
<p >The documentation can be built with the following command:</p>
<div class="fragment"><div class="line">$ make gen_docs</div>
</div><!-- fragment --><blockquote class="doxtable">
<p >‍[!NOTE] Doxygen is required to build the documentation. </p>
</blockquote>
<h1><a class="anchor" id="autotoc_md10"></a>
Support</h1>
<p >Any question or issue related to CogLink or other PerformanC projects can be can be made in <a href="https://discord.gg/uPveNfTuCJ">PerformanC's Discord server</a>.</p>
<p >For verified issues, please also create a GitHub issue for tracking the issue.</p>
<h1><a class="anchor" id="autotoc_md11"></a>
Contributing</h1>
<p >CogLink follows the PerformanC's <a href="https://github.com/PerformanC/contributing">contribution guidelines</a>. It is necessary to follow the guidelines to contribute to CogLink and other PerformanC projects.</p>
<h1><a class="anchor" id="autotoc_md12"></a>
Projects using CogLink</h1>
<p >None known yet, but if you are using CogLink, please let us know in <a href="https://discord.gg/uPveNfTuCJ">PerformanC's Discord server</a> and we will add your project here.</p>
<h1><a class="anchor" id="autotoc_md13"></a>
License</h1>
<p >CogLink is licensed under [BSD 2-Clause License](LICENSE). You can read more about it on <a href="https://opensource.org/licenses/BSD-2-Clause">Open Source Initiative</a>.</p>
<ul>
<li>This project uses the latest standards of The PerformanC Organization. </li>
</ul>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>