Welcome to mk-project’s documentation!

Contents:

mk-project

What mk-project provide ?

mk-project generate you a Makefile based project

fully according to your settings...

  • You can compile, launch, debug, profiling...
  • You can format your source code with several tools !
  • You can generate documentation based on:

texinfo, ReST or Markdown files.

With many output possiblities:

man, info, html, pdf, epub...

  • You can create an archive from your project !

And mk-project provide many others features !!!

Note

Once installed you can hack the code grace of the Makefile provided

in the installing directory.

The little story of mk-project

I have study in depth the GNU make manual and become acquainted with the

make tool. So that I have implemented many targets in a big

Makefile starting by simply automating the compilation process and

the executable launching tasks...

So I have construct a big Makefile for all sort of purposes.

Motivation for writing mk-project

I need a Makefile every time i write a program, library or a script.

So I decide to write a program which generate a Makefile according to the wanted settings.

Which automate all the task i used to use or that i need sometimes.

And because a i use my I.T.E it-edit

for writing programs i can simply type the targets into the terminals sidebar of it-edit

all that by writing my source codes...

Launching mk-project

You can launch mk-project in a terminal with a *.mkp file given as argument

$ mk-project /path/to/project_folder/prgname.mkp

Or by using your file manager:

Simply click on the *.mkp file in the project folder

or

Opening the *.mkp file with your file manager using the open with option.

To open the mk-project G.U.I and loading the entire project.

mk-project G.U.I

The mk-project G.U.I is composed of a menubar and terminals.

The menubar contains following items:

  1. The Projects item which is done for
  • Generate a new project.

    Projects -> New project Ctrl + N

  • Reconfigure a project.

    Projects -> Reconfigure project Ctrl + R

  • Add files to the project.

    Projects -> Add file(s) to project Ctrl + A

  • Load a project.

    Projects -> Load project Ctrl + L

  1. The Terminals item which is done for switching between the 2 sort of terminals:
  • The make terminal Terminals -> make terminal Ctrl + m

    Which output the make targets everytime you launch one through the G.U.I.

  • The edit terminal Terminals -> edit terminal Ctrl + e is suppose for ed, vi, emacs, etc users.

    You can add and remove as many tabs as you want to this, so that you can

    work on your source files by using mk-project.

    Note

    Thanks to notify me at <mrcyberfighter@gmail.com> if some keyboard shortcut(s)

    get into conflict with your editor shortcuts.

  1. The targets item which display severals submenus for launching make targets accroding to your project configuration.
  2. The Configuration item which permit to configure the terminals.
  3. The Info item which permit to launch the HTML documenation of mk-project or the about window.

Shortcuts memo

+--------------------+------------------------+-------------------+
|    Shortcut        |    functionality       |    Mnemonic       |
+====================+========================+===================+
| Ctrl + n           | New project            | n = new           |
+--------------------+------------------------+-------------------+
| Ctrl + r           | Reconfigure project    | r = reconfigure   |
+--------------------+------------------------+-------------------+
| Ctrl + l           | Load project           | l = load          |
+--------------------+------------------------+-------------------+
| Ctrl + a           | Add file(s) to project | a = add           |
+--------------------+------------------------+-------------------+
| Ctrl + m           | make terminal          | m = make          |
+--------------------+------------------------+-------------------+
| Ctrl + e           | editing terminal       | e = editing       |
+--------------------+------------------------+-------------------+
| Ctrl + Maj + c     | configuration          | c = configuration |
+--------------------+------------------------+-------------------+

Credits

Author:

Eddie Brüggemann

Contact:

mrcyberfighter@gmail.com

License:

GPLv3.

version:

1.0.0

website:

<http://www.open-source-projects.net/mk-project/mk-project_presentation.html>

Thank’s to my beloved mother, my family and to the doctors.

Stay away from drugs: drugs destroy your brain and your life.