Added a readme.

This commit is contained in:
eisbaer 2022-10-30 23:12:37 +01:00
parent df6fd81872
commit 4f94ae35c7
2 changed files with 19 additions and 1 deletions

18
README.org Normal file
View File

@ -0,0 +1,18 @@
* cHelper for emacs
** What is this?
cHelper is a collection of functions for cleaning up C code. It's far from finished but I happen to use it's
only function from time to time.
** How does it work?
Well... I was to lazy for writing a regex that detects C functions. That made me write a Python script which does
that with the help of the KMeans clustering algorithm. (See how in cluster.ipynb)
cluster.pkl is the pickeled KMeans and main.py loads and calls it on the c file of your choice.
** What does it do?
Right now the only usefull fuction is the chelper-make-header-from-source elisp function. You can call it when
you are in the buffer of your c source file and it will create a .h file from it.
The created .h file will be named after the c file and contain all the function declarations of all the functions you
defined in your c file.
** How do I use it?
Put this Folder in your .emacs.d and load it. If you installed scikit (pip3 install scikit-learn) you can use the
chelper-make-header-from-source function by calling it with M-x.
[[https://eisbaer.tilde.team][Eisbaer]]

View File

@ -1,4 +1,4 @@
;;; this file contains functions which write a c header file for you
;;; this file contains funcqtions which write a c header file for you
;;; automatically
;;; Code: