This repository has been archived on 2019-10-11. You can view files and clone it, but cannot push or open issues or pull requests.
compilescript/README.adoc

76 lines
1.9 KiB
Plaintext
Raw Permalink Normal View History

2019-03-05 22:45:17 +01:00
= compilescript
2019-05-24 16:57:02 +02:00
*compilescript* allows you to execute files from compiled languages like scripts.
2019-03-16 22:33:18 +01:00
By default it uses `g++`.
2018-12-28 13:56:34 +01:00
It compiles the source file, stores the binary in
`${XDG_CACHE_HOME}/compilescript/` and executes it. If the binary in cache is
2019-01-01 09:07:39 +01:00
newer than the source file, the compilation is skipped.
2018-12-29 05:33:58 +01:00
2019-03-05 22:45:17 +01:00
== Usage
2018-12-29 05:33:58 +01:00
2019-10-01 12:02:08 +02:00
Have a look at the https://schlomp.space/tastytea/compilescript/src/branch/main/man/compilescript.1.adoc[manpage].
2018-12-29 05:33:58 +01:00
2019-03-05 22:45:17 +01:00
== Install
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
=== Gentoo
2019-01-01 09:05:31 +01:00
Gentoo ebuilds are available via my
2019-03-05 22:45:17 +01:00
https://schlomp.space/tastytea/overlay[repository].
2019-01-01 09:05:31 +01:00
2019-03-05 22:45:17 +01:00
=== From source
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
==== Dependencies
2018-12-28 13:56:34 +01:00
2019-05-24 17:02:31 +02:00
* C++ compiler (tested: https://gcc.gnu.org/[gcc] 5/6/8/9,
https://llvm.org/[clang] 3/6)
2019-03-05 22:45:17 +01:00
* https://cmake.org/[cmake] (at least 3.2)
* http://repo.or.cz/w/libxdg-basedir.git[libxdg-basedir] (tested: 1.2)
* https://github.com/hyperrealm/libconfig[libconfig++] (tested: 1.5)
2019-01-31 18:35:46 +01:00
* Optional:
2019-03-05 22:49:17 +01:00
** Manpage: http://asciidoc.org/[asciidoc] (tested: 8.6)
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
==== Get sourcecode
2018-12-28 13:56:34 +01:00
Download the current
2019-03-05 22:45:17 +01:00
https://schlomp.space/tastytea/compilescript/releases[release] and copy
https://schlomp.space/tastytea/xdgcfg[xdgcfg] into `xdgcfg/`,
2019-03-05 22:32:25 +01:00
2019-03-05 22:45:17 +01:00
.or clone with git:
[source,sh]
----
2019-03-05 22:32:25 +01:00
git clone https://schlomp.space/tastytea/compilescript.git
cd compilescript
git submodule init
git submodule update
2019-03-05 22:45:17 +01:00
----
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
==== Compile
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
[source,sh]
----
2018-12-28 13:56:34 +01:00
mkdir build
cd build
cmake ..
make
make install
2019-03-05 22:45:17 +01:00
----
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
.cmake options:
2019-01-31 18:35:46 +01:00
* `-DCMAKE_BUILD_TYPE=Debug` for a debug build
* `-DWITH_MAN=NO` to not compile the manpage
2019-03-05 22:45:17 +01:00
== Contributing
2018-12-28 13:56:34 +01:00
Contributions are always welcome. You can submit them as pull requests or via
email to `tastytea`@`tastytea.de`.
2019-03-05 22:45:17 +01:00
== License & Copyright
2018-12-28 13:56:34 +01:00
2019-03-05 22:45:17 +01:00
----
2019-03-05 22:32:25 +01:00
Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>.
2018-12-28 13:56:34 +01:00
License GPLv3: GNU GPL version 3 <https://www.gnu.org/licenses/gpl-3.0.html>.
This program comes with ABSOLUTELY NO WARRANTY. This is free software,
and you are welcome to redistribute it under certain conditions.
2019-03-05 22:45:17 +01:00
----