From c2cd56f94a5b490cca6734606ed706fa43c56608 Mon Sep 17 00:00:00 2001 From: jem Date: Fri, 12 Mar 2021 14:25:06 +0100 Subject: [PATCH] add dev & releasing doc --- doc/Developement.md | 15 +++++++++++++++ doc/Releasing.md | 17 +++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 doc/Developement.md create mode 100644 doc/Releasing.md diff --git a/doc/Developement.md b/doc/Developement.md new file mode 100644 index 0000000..f7fd95b --- /dev/null +++ b/doc/Developement.md @@ -0,0 +1,15 @@ +# Project Setup + +## dev environment + +``` +sudo apt install npm +sudo npm install -g npx + +# maybe +sudo npm install -g shadow-cljs + +# in project root to retrieve all dependencies +npm install --ignore-scripts +npx shadow-cljs compile test +``` diff --git a/doc/Releasing.md b/doc/Releasing.md new file mode 100644 index 0000000..549fafb --- /dev/null +++ b/doc/Releasing.md @@ -0,0 +1,17 @@ +# stable release (should be done from master) + +``` +#adjust [version] +vi package.json +vi project.clj + +git commit -am "release" +git tag -am "release" [release version no] +git push --follow-tags + +# bump version - increase version and add -SNAPSHOT +vi package.json +vi project.clj +git commit -am "version bump" +git push +``` \ No newline at end of file