From 3c7b57bba936bf2c120152b73554acb9cfbdb637 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 27 Sep 2015 02:11:38 +0200 Subject: Convert README to AsciiDoc --- README.adoc | 68 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 68 insertions(+) create mode 100644 README.adoc (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..bc9d724 --- /dev/null +++ b/README.adoc @@ -0,0 +1,68 @@ +acid +==== + +'acid' is A Continuous Integration Daemon. Currently under heavy development. +Right now I'm working on a demo JSON-RPC server that will serve as the basis for +the final daemon. + +The aim of this project is to provide a dumbed-down alternative to Travis CI. +I find it way too complex to set up and run in a local setting, while the basic +gist of it is actually very simple -- run some stuff on new git commits. + +'acid' will provide a JSON-RPC 2.0 service for frontends over FastCGI, SCGI, or +WebSockets, as well as a webhook endpoint for notifications about new commits. +The daemon is supposed to be "firewalled" by a normal HTTP server and it will +not provide TLS support to secure the communications. + +'acid' will be able to tell you about build results via e-mail and/or IRC. + +Builds will only be supported on the same machine as the daemon. Eventually I +might be able to add support for fully replicable builds using Docker. + +With this being my own project, of course it is written in event-looped C99 +where everything is stuffed into just a few files. At least I hope it's written +in a somewhat clean manner. Feel free to contribute. + +Building and Installing +----------------------- +Build dependencies: CMake, pkg-config, help2man, libmagic, + liberty (included), http-parser (included) + +Runtime dependencies: libev, Jansson + + $ git clone --recursive https://github.com/pjanouch/acid.git + $ mkdir acid/build + $ cd acid/build + $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug + $ make + +To install the application, you can do either the usual: + + # make install + +Or you can try telling CMake to make a package for you. For Debian it is: + + $ cpack -G DEB + # dpkg -i acid-*.deb + +Note that for versions of CMake before 2.8.9, you need to prefix `cpack` with +`fakeroot` or file ownership will end up wrong. + +Usage +----- +TODO. The main application hasn't been written yet. + +Contributing and Support +------------------------ +Use this project's GitHub to report any bugs, request features, or submit pull +requests. If you want to discuss this project, or maybe just hang out with +the developer, feel free to join me at irc://anathema.irc.so, channel #anathema. + +License +------- +'acid' is written by Přemysl Janouch . + +You may use the software under the terms of the ISC license, the text of which +is included within the package, or, at your option, you may relicense the work +under the MIT or the Modified BSD License, as listed at the following site: + +http://www.gnu.org/licenses/license-list.html -- cgit v1.2.3 From 7b94a03e8c304682871e2e6e229934e3d493d208 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Mon, 14 Mar 2016 21:18:27 +0100 Subject: Update IRC server address --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc index bc9d724..3781b97 100644 --- a/README.adoc +++ b/README.adoc @@ -55,7 +55,7 @@ Contributing and Support ------------------------ Use this project's GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with -the developer, feel free to join me at irc://anathema.irc.so, channel #anathema. +the developer, feel free to join me at irc://irc.janouch.name, channel #dev. License ------- -- cgit v1.2.3 From 419147beecc8bd9e62aa370422ef8808f67d42f1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Tue, 20 Jun 2017 14:01:10 +0200 Subject: Update README --- README.adoc | 2 ++ 1 file changed, 2 insertions(+) (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc index 3781b97..e8f0404 100644 --- a/README.adoc +++ b/README.adoc @@ -57,6 +57,8 @@ Use this project's GitHub to report any bugs, request features, or submit pull requests. If you want to discuss this project, or maybe just hang out with the developer, feel free to join me at irc://irc.janouch.name, channel #dev. +Bitcoin donations: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9 + License ------- 'acid' is written by Přemysl Janouch . -- cgit v1.2.3 From 4078c8845ce4549edb23e3138e45d32af8858ee5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 24 Jun 2018 00:21:10 +0200 Subject: Relicense to 0BSD, update mail address I've come to the conclusion that copyright mostly just stands in the way of software development. In my jurisdiction I cannot give up my own copyright and 0BSD seems to be the closest thing to public domain. The updated mail address, also used in my author/committer lines, is shorter and looks nicer. People rarely interact anyway. --- README.adoc | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc index e8f0404..2f80d73 100644 --- a/README.adoc +++ b/README.adoc @@ -61,10 +61,5 @@ Bitcoin donations: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9 License ------- -'acid' is written by Přemysl Janouch . - -You may use the software under the terms of the ISC license, the text of which -is included within the package, or, at your option, you may relicense the work -under the MIT or the Modified BSD License, as listed at the following site: - -http://www.gnu.org/licenses/license-list.html +This software is released under the terms of the 0BSD license, the text of which +is included within the package along with the list of authors. -- cgit v1.2.3 From b312c022ae28e0852cba7430465971a2a391f016 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?P=C5=99emysl=20Janouch?= Date: Sun, 24 Jun 2018 00:21:32 +0200 Subject: Update README --- README.adoc | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) (limited to 'README.adoc') diff --git a/README.adoc b/README.adoc index 2f80d73..80d708f 100644 --- a/README.adoc +++ b/README.adoc @@ -29,7 +29,7 @@ Build dependencies: CMake, pkg-config, help2man, libmagic, liberty (included), http-parser (included) + Runtime dependencies: libev, Jansson - $ git clone --recursive https://github.com/pjanouch/acid.git + $ git clone --recursive https://git.janouch.name/p/acid.git $ mkdir acid/build $ cd acid/build $ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Debug @@ -53,11 +53,11 @@ TODO. The main application hasn't been written yet. Contributing and Support ------------------------ -Use this project's GitHub to report any bugs, request features, or submit pull -requests. If you want to discuss this project, or maybe just hang out with -the developer, feel free to join me at irc://irc.janouch.name, channel #dev. +Use https://git.janouch.name/p/acid to report any bugs, request features, +or submit pull requests. `git send-email` is tolerated. If you want to discuss +the project, feel free to join me at ircs://irc.janouch.name, channel #dev. -Bitcoin donations: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9 +Bitcoin donations are accepted at: 12r5uEWEgcHC46xd64tt3hHt9EUvYYDHe9 License ------- -- cgit v1.2.3