summaryrefslogtreecommitdiff
path: root/README.md
blob: 635d2d125b447138f522d213129356b649a8940f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
# PeriJect: A git-backed task management system

Data is stored through a folder hierarchy in yaml data files. Data can be
edited by hand and validated using the provided schema files or tools can be
developed to aid the creation and manipulation of the data sources.

## Project Dependancies:

 - pykwalify:

   Documentation: https://pykwalify.readthedocs.io/
   Installation: pip3 install pykwalify

   Custom validation is possible with pykwalify which may assist with complex
   use cases in the future. See:

   -  https://pykwalify.readthedocs.io/en/unstable/extensions.html#how-custom-validation-works

# ject

## How to use ?
You can check project via ject command.
You need to install python-yaml package. If you are using ubuntu, it will be

	> sudo apt install python3-pip
	> sudo pip3 install --upgrade pip
	> sudo pip3 install pyyaml

You need to have **.config** file. You can copy sample .config, and edit it

`cp  .config.sample .config`

## options

 * key : show matched key task
   - ject 7ddd3743-fa13-4966-bcf0-10609b873ab5
   - ject 7ddd3743-fa13-4966-bcf0-10609b873ab5 e704e989-ccaa-48a5-8f58-28c5b93467ff
 * -s  : show   matched status task
 * -ns : show unmatched status task
   - ject -s Active ...     # single match
   - ject -s Active,New ... # multi match
   - ject -ns Done          # not match
 * -a  : show   matched assignee task
 * -as : show unmatched assignee task
   - ject -a Wolfram ...
   - ject -na Morimoto,Shimoda ...
 * -t  : show   matched team task
 * -at : show unmatched team task
   - ject -t IO,MM ...
   - ject -nt Core ...
 * -f : show with file name
 * -r : show with relationships
 * --oneline : show one line
 * --all : show all tasks

# HTML / Wiki

## How to create HTML ?

You need to install "textile" first for Wiki, by using one of:

	> pip install textile
or
	> sudo apt install python3-textile

Next, you need to have **.config** file. You can copy sample .config, and edit it

Your .config need to have "git-linux" and it needs to have these repositories.

	> git remote add linux      git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
	> git remote add bsp        git://git.kernel.org/pub/scm/linux/kernel/git/horms/renesas-bsp.git
	> git remote add linux-next git://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git

Then, just "make".
You can find index.html on top of periject folder