~lucasemmoreira/hitter

6b3b739f58de7462698d0f3c307a0bfd57fe2d76 — Lucas Moreira 2 years ago 818ad70
add: readme and makefile
3 files changed, 56 insertions(+), 0 deletions(-)

A README.md
A README.org
A makefile
A README.md => README.md +22 -0
@@ 0,0 1,22 @@


# What is this?

It is a simple janet program that checks multiple url status.


# How can I use it?

It is very simple. The most straight foward way is to clone and run
\#+begin<sub>src</sub> sh
sudo make deps
make install
\#+end<sub>src</sub>.
The urls you want to check are in \`$HOME/.config/hitter/urls\`.
As far as I can tell, janet can only install dependencies with root permission, but after that, to build no admin is necessary anymore. So in the makefile you probably need to specify a local \`$PATH\`. Of course, you can put in \`/usr/bin/\`, and if so, run \`make install\` with sudo =].


# Didn't like it&#x2026;

No problem! \`make uninstall\`.


A README.org => README.org +18 -0
@@ 0,0 1,18 @@
#+Title: Hitter
#+Author: Lucas Moreira
#+Mail: me@lucasemmoreira.xyz

* What is this?
  It is a simple janet program that checks multiple url status.
  
* How can I use it?
  It is very simple. The most straight foward way is to clone and run
  #+begin_src sh
  sudo make deps
  make install
  #+end_src.
  The urls you want to check are in `$HOME/.config/hitter/urls`.
  As far as I can tell, janet can only install dependencies with root permission, but after that, to build no admin is necessary anymore. So in the makefile you probably need to specify a local `$PATH`. Of course, you can put in `/usr/bin/`, and if so, run `make install` with sudo =].

* Didn't like it...
  No problem! `make uninstall`.

A makefile => makefile +16 -0
@@ 0,0 1,16 @@
config_path = ~/.config/hitter/
config_file := $(config_path)urls
url_dummy = 'example localhost:8000'
bin_dir = ~/.local/bin/hitter
run:
	janet src/main.janet
deps:
	jpm deps
install:
	mkdir $(config_path) 
	echo $(url_dummy) > $(config_file)
	jpm build
	cp build/hitter $(bin_dir)
uninstall:
	rm -r $(config_path)
	rm $(bin_dir)