This repo contains many of my own project boilerplate code. Some of it is documentation specific and others coding projects.
Most of these are mkproj templates that macro compile out to a project.
- Lein project: boilerplate for Leiningen.
- Maven project: boilerplate for Maven
- Scala project: Boilerplate simple built tool (SBT) project to build Scala projects with Ensime ane Emacs.
- LaTeX environment:
boilerplate setup
for Latex documents,
which include:
- Design/architecture documentation--includes handy bib setup
- Academic papers
- Academic slides
- Emacs Lisp Package: boilerplate for Emacs Lisp and includes support for:
I'll provide an example via a use case with a Clojure project. First you'll need to install the dependencies.
The recommended process is (see script version):
- Clone the template (this repo):
mkdir template && \
wget -O - https://api.github.com/repos/plandes/template/tarball | \
tar zxfv - -C template --strip-components 1- Download the mkproj boilerplate project starter:
mkdir mkproj && \
wget -O - https://github.com/plandes/clj-mkproj/releases/download/v0.0.7/mkproj.tar.bz2 | \
tar jxfv - -C mkproj --strip-components 1- Get zenbuild system by cloning or:
mkdir zenbuild && \
wget -O - https://api.github.com/repos/plandes/zenbuild/tarball | \
tar zxfv - -C zenbuild --strip-components 1- Create (for example) a Clojure boilerplate project or choose from a directory
in
./template(note that not all are mkproj projects):
/bin/bash ./mkproj/bin/mkproj config -s template/lein- Optionally make changes to the project parameters
mkproj.ymlfile (for any serious work you'll have to edit this file):
vi mkproj.yml- Build out the project from the template:
/bin/bash ./mkproj/bin/mkproj- Create an initial commit baseline for the project and create an uberjar:
make -C clj-someproj init uber- Run the executable jar from the command line:
java -jar clj-someproj/target/someproj-0.0.1-standalone.jar Copyright © 2016 - 2017 Paul Landes
GNU Lesser General Public License, Version 2.0