Update README and other files, add site/
This commit is contained in:
parent
6c05056f84
commit
dd41bb1272
8 changed files with 220 additions and 55 deletions
24
CONTRIBUTING
Normal file
24
CONTRIBUTING
Normal file
|
@ -0,0 +1,24 @@
|
|||
# -*- mode: org; -*-
|
||||
#+STARTUP: showall
|
||||
|
||||
If you wish to contribute you can use either the sources located on
|
||||
[[http://code.ryuslash.org/cgit.cgi/gitto/][ryuslash.org]] or the [[https://github.com/ryuslash/gitto][github]] sources.
|
||||
|
||||
* Getting the source
|
||||
|
||||
If you wish to work on ~gitto~ you can get the sources by cloning the
|
||||
repository:
|
||||
|
||||
: git clone git://ryusalsh.org/git-auto-commit-mode.git
|
||||
|
||||
* Style
|
||||
|
||||
Use spaces, don't use tabs. If you can, keep lines shorter than 80
|
||||
characters. Other than that, Emacs can handle indentation pretty
|
||||
well. [[http://www.nongnu.org/geiser/][Geiser]] can help too, if you're using Emacs.
|
||||
|
||||
* Patches
|
||||
|
||||
If you want to send any patches I prefer an email with the output
|
||||
generated by =git request-pull=, possibly with =-p=, over things like
|
||||
github pull requests, but nothing will be turned away.
|
36
INSTALL
Normal file
36
INSTALL
Normal file
|
@ -0,0 +1,36 @@
|
|||
# -*- mode: org; -*-
|
||||
#+STARTUP: showall
|
||||
|
||||
In order to install ~gitto~, just run:
|
||||
|
||||
: make install
|
||||
|
||||
This will install ~gitto~ to ~/usr/local/~, if you would like to install
|
||||
it somewhere else you can use the =DESTDIR= variable:
|
||||
|
||||
: make install DESTDIR=/some/other/place
|
||||
|
||||
This will install ~gitto~ to =/some/other/place/=.
|
||||
|
||||
* Packages
|
||||
|
||||
- There is also a [[https://aur.archlinux.org/packages/gitto-git/][package]] in the [[http://aur.archlinux.org][Archlinux User Repository]], which
|
||||
installs the latest git checkout.
|
||||
|
||||
* Requirements
|
||||
|
||||
~gitto~ requires [[http://www.gnu.org/software/guile/][GNU Guile]] version 2.0.9 or newer to be available.
|
||||
|
||||
* Removal
|
||||
|
||||
If you're fed up with ~gitto~ and want it gone you can run:
|
||||
|
||||
: make uninstall
|
||||
|
||||
This will remove any ~gitto~ installed files from ~/usr/local/~. If you
|
||||
used the =DESTDIR= variable during installation, you should give it
|
||||
the same value here, like:
|
||||
|
||||
: make uninstall DESTDIR=/some/other/place
|
||||
|
||||
This will remove any ~gitto~ installed files from ~/some/other/place/~.
|
98
README.org
98
README.org
|
@ -1,71 +1,59 @@
|
|||
* Gitto
|
||||
#+TITLE: gitto
|
||||
#+STARTUP: showall
|
||||
|
||||
* NAME
|
||||
|
||||
gitto - A silly utility to track the status of some git
|
||||
repositories.
|
||||
|
||||
* SYNOPSIS
|
||||
|
||||
=gitto [command [subcommand] [args...]]=
|
||||
|
||||
* DESCRIPTION
|
||||
|
||||
For lack of a better title.
|
||||
|
||||
My simple utility to keep track of all the git repositories I have
|
||||
on my computer(s). Also an experiment in writing scheme.
|
||||
My simple utility to keep track of all the git repositories I have on
|
||||
my computer(s). Also an experiment in writing scheme.
|
||||
|
||||
Written for [[http://gnu.org/software/guile][GNU Guile]] 2.0.x
|
||||
Written for [[http://gnu.org/software/guile][GNU Guile]] 2.0.9 or newer
|
||||
|
||||
** Installation
|
||||
* USAGE
|
||||
|
||||
Installing ~gitto~ is not really necessary, but it *is* more
|
||||
convenient. In order to install it just run:
|
||||
Usage is, hopefully, simple, first you have to register some repos:
|
||||
|
||||
: make install
|
||||
: $ gitto add ~/projects/project1
|
||||
: $ gitto add ~/projects/project2
|
||||
: $ gitto add ~/projects/project3
|
||||
|
||||
This will install ~gitto~ to ~/usr/local/~, if you would like it
|
||||
somewhere else you could use the ~DESTDIR~ variable:
|
||||
Then you can call ~gitto~ without any argument to see a list of your
|
||||
repos and their statuses:
|
||||
|
||||
: make install DESTDIR=/some/other/place
|
||||
: $ gitto
|
||||
: project1: Worktree is dirty
|
||||
: master: 0 to push and 0 to pull. Last update: 4 weeks ago
|
||||
:
|
||||
: project2: Worktree is clean
|
||||
: master: 5 to push and 2 to pull. Last update: 2 days ago
|
||||
:
|
||||
: project3: Worktree is clean
|
||||
: master: 0 to push and 1 to pull. Last update: 1 hour ago
|
||||
|
||||
This will install ~gitto~ to ~/some/other/place/~.
|
||||
If you're done with one of your projects and no longer wish to track
|
||||
their status you can unregister them:
|
||||
|
||||
** Removal
|
||||
: $ gitto remove ~/projects/project1
|
||||
|
||||
If you're fed up with ~gitto~ and want it gone, and I do mean *now*,
|
||||
you can run:
|
||||
If you require further assistance:
|
||||
|
||||
: make uninstall
|
||||
: $ gitto help
|
||||
|
||||
This will remove any ~gitto~ installed files from ~/usr/local/~, if you
|
||||
used the ~DESTDIR~ variable during installation, you should give it
|
||||
the same value here, like:
|
||||
** run-gitto
|
||||
|
||||
: make uninstall DESTDIR=/some/other/place
|
||||
It is not strictly necessary to install gitto, I have added a
|
||||
utility to run it straight from je project directory, although
|
||||
mostly for testing purposes.
|
||||
|
||||
This will remove any ~gitto~ installed files from ~/some/other/place/~.
|
||||
|
||||
** Usage
|
||||
|
||||
Usage is, hopefully, simple, first you have to register some repos:
|
||||
|
||||
: $ gitto -r ~/projects/project1
|
||||
: $ gitto -r ~/projects/project2
|
||||
: $ gitto -r ~/projects/project3
|
||||
|
||||
Then you can call ~gitto~ without any argument to see a list of your
|
||||
repos and their statuses:
|
||||
|
||||
: $ gitto
|
||||
: project1: 0 to push, 0 to pull and is dirty
|
||||
: project2: 5 to push, 2 to pull and is not dirty
|
||||
: project3: 0 to push, 1 to pull and is not dirty
|
||||
|
||||
If you're done with one of your projects and no longer wish to
|
||||
track their status you can unregister them:
|
||||
|
||||
: $ gitto -R ~/projects/project1
|
||||
|
||||
If you require further assistance:
|
||||
|
||||
: $ gitto -h
|
||||
|
||||
*** run-gitto
|
||||
|
||||
As I mentioned, it is not completely necessary to install gitto, I
|
||||
have added a utility to run it straight from je project directory,
|
||||
although mostly for testing purposes.
|
||||
|
||||
Using ~run-gitto~ works exactly the same as using ~gitto~ when it is
|
||||
installed.
|
||||
Using ~run-gitto~ works exactly the same as using ~gitto~ when it is
|
||||
installed.
|
||||
|
|
1
site/.gitignore
vendored
Normal file
1
site/.gitignore
vendored
Normal file
|
@ -0,0 +1 @@
|
|||
_publish/
|
10
site/Makefile
Normal file
10
site/Makefile
Normal file
|
@ -0,0 +1,10 @@
|
|||
.PHONY: export publish
|
||||
|
||||
all:
|
||||
|
||||
export:
|
||||
emacs -batch -l project.el -f org-publish-all
|
||||
|
||||
publish: export
|
||||
rsync -avuz --delete --exclude='*~' _publish/ \
|
||||
ryuslash.org:public_html/orgweb/projects/gitto
|
21
site/index.org
Normal file
21
site/index.org
Normal file
|
@ -0,0 +1,21 @@
|
|||
#+TITLE: gitto
|
||||
#+HTML_LINK_HOME: http://ryuslash.org
|
||||
#+OPTIONS: num:nil toc:nil author:nil
|
||||
#+STARTUP: showall
|
||||
#+STYLE: <link rel="stylesheet" type="text/css" href="stylesheet.css" />
|
||||
|
||||
#+BEGIN_CENTER
|
||||
[[http://code.ryuslash.org/cgit.cgi/gitto/][Browse source]]
|
||||
[[http://blog.ryuslash.org/tags/gitto][Read posts]]
|
||||
Dowlnoad: [[http://code.ryuslash.org/cgit.cgi/gitto/snapshot/gitto-master.tar.gz][TAR.GZ]], [[http://code.ryuslash.org/cgit.cgi/gitto/snapshot/gitto-master.zip][ZIP]]
|
||||
#+END_CENTER
|
||||
|
||||
#+INCLUDE: "../README.org"
|
||||
|
||||
* INSTALLING
|
||||
|
||||
#+INCLUDE: "../INSTALL" :minlevel 2
|
||||
|
||||
* CONTRIBUTING
|
||||
|
||||
#+INCLUDE: "../CONTRIBUTING" :minlevel 2
|
17
site/project.el
Normal file
17
site/project.el
Normal file
|
@ -0,0 +1,17 @@
|
|||
(require 'org-publish)
|
||||
|
||||
(setq org-publish-project-alist
|
||||
'(("gitto-files"
|
||||
:base-directory "./"
|
||||
:publishing-directory "_publish/"
|
||||
:recursive nil
|
||||
:base-extension "css"
|
||||
:publishing-function org-publish-attachment)
|
||||
("gitto-org"
|
||||
:base-directory "./"
|
||||
:publishing-directory "_publish"
|
||||
:recursive nil
|
||||
:base-extension "org"
|
||||
:publishing-function org-publish-org-to-html)
|
||||
("gitto-site"
|
||||
:components ("gitto-org" "gitto-files"))))
|
68
site/stylesheet.css
Normal file
68
site/stylesheet.css
Normal file
|
@ -0,0 +1,68 @@
|
|||
a
|
||||
{
|
||||
color: #6d97bf;
|
||||
}
|
||||
|
||||
a:visited
|
||||
{
|
||||
color: #b27dbf;
|
||||
}
|
||||
|
||||
body
|
||||
{
|
||||
font-family: "DejaVu Sans", sans-serif;
|
||||
background-color: #222224;
|
||||
color: #eeeeec;
|
||||
}
|
||||
|
||||
code,
|
||||
pre
|
||||
{
|
||||
font-family: "Envy Code R", monospace;
|
||||
}
|
||||
|
||||
h3, h4,
|
||||
.outline-text-2,
|
||||
.outline-text-3,
|
||||
.outline-text-4
|
||||
{
|
||||
margin-left: 20px;
|
||||
}
|
||||
|
||||
pre
|
||||
{
|
||||
background-color: #111113;
|
||||
color: #eeeeec;
|
||||
border: 1px solid #a5a5a4;
|
||||
border-radius: 2px;
|
||||
}
|
||||
|
||||
ul
|
||||
{
|
||||
margin-left: -20px;
|
||||
}
|
||||
|
||||
#content
|
||||
{
|
||||
width: 700px;
|
||||
}
|
||||
|
||||
#org-div-home-and-up
|
||||
{
|
||||
width: 750px;
|
||||
}
|
||||
|
||||
#postamble
|
||||
{
|
||||
font-size: 12px;
|
||||
padding: 3px 5px;
|
||||
border: 1px solid #a5a5a4;
|
||||
width: 690px;
|
||||
}
|
||||
|
||||
#postamble p
|
||||
{
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
line-height: 1.3em;
|
||||
}
|
Loading…
Reference in a new issue