Skip to content

Commit 8581988

Browse files
author
Christian Richter
committed
Add LICENSE & Readme.md
Signed-off-by: Christian Richter <crichter@suse.com>
1 parent 520035f commit 8581988

2 files changed

Lines changed: 42 additions & 0 deletions

File tree

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Christian Richter
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# github2orgmode
2+
3+
github2orgmode is a small tool to convert issues from defined repositories into
4+
an org file.
5+
6+
## License
7+
8+
MIT see [LICENSE](https://github.com/dragonchaser/github2orgmode/blob/master/LICENSE) file in this repository.
9+
10+
## Build
11+
12+
Just run `make` in the project folder, binary can be found in `bin/`
13+
14+
## Run
15+
16+
```
17+
$> GH_TOKEN=<your-personal-github-access-token> GH_REPOS="org1/repo1 org1/repo2"
18+
bin/github2orgmode > output.org
19+
```
20+
21+
The personal github access token can be created in your profile page [https://github.com/settings/tokens](https://github.com/settings/tokens).

0 commit comments

Comments
 (0)