aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiquel Sabaté Solà <msabate@suse.com>2023-01-02 12:53:26 +0100
committerMiquel Sabaté Solà <msabate@suse.com>2023-01-02 13:04:13 +0100
commit57d49ddffa09ba524e2a344339ed0513c9fc6c20 (patch)
treef56572146427fc0afd3ec12256ae6786f929cbae
parentcf5b286fc06bf606b2b234ef27d4935d265a9c93 (diff)
downloadg-57d49ddffa09ba524e2a344339ed0513c9fc6c20.tar.gz
g-57d49ddffa09ba524e2a344339ed0513c9fc6c20.zip
ci: travis -> github
Signed-off-by: Miquel Sabaté Solà <msabate@suse.com>
-rw-r--r--.github/workflows/ci.yml16
-rw-r--r--.travis.yml7
-rw-r--r--README.md (renamed from README.org)41
3 files changed, 36 insertions, 28 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
new file mode 100644
index 0000000..9ec8993
--- /dev/null
+++ b/.github/workflows/ci.yml
@@ -0,0 +1,16 @@
+name: CI
+
+on:
+ push:
+ branches: [main]
+ pull_request:
+ branches: [main]
+
+jobs:
+ tests:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v2
+
+ - name: Run tests
+ run: make unit-test
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index 91c6657..0000000
--- a/.travis.yml
+++ /dev/null
@@ -1,7 +0,0 @@
-language: bash
-sudo: required
-services:
- - docker
-
-script:
- - make
diff --git a/README.org b/README.md
index 270fdb7..ab30559 100644
--- a/README.org
+++ b/README.md
@@ -1,20 +1,24 @@
-* Yeah! just one letter !
-[[https://travis-ci.org/mssola/g][https://travis-ci.org/mssola/g.svg?branch=master]]
+<p align="center">
+ <a href="https://github.com/mssola/g/actions?query=workflow%3ACI" title="CI status for the main branch"><img src="https://github.com/mssola/g/workflows/CI/badge.svg" alt="Build Status for main branch" /></a>
+ <a href="http://www.gnu.org/licenses/gpl-3.0.txt" rel="nofollow"><img alt="License GPL 3" src="https://img.shields.io/badge/license-GPL_3-blue.svg" style="max-width:100%;"></a>
+</p>
+
+---
This repository holds a very humble and simple script that handles shortcuts of
bash paths. For example:
-#+BEGIN_SRC bash
+``` sh
$ g awesome
# instead of ...
$ cd /home/user/directory/dir/awesome
-#+END_SRC
+```
Furthermore, this repo also brings a file that adds bash completion so the user
can access the desired directory as fast as possible. In order to manage
shortcuts, this script accepts three commands:
-#+BEGIN_SRC bash
+``` sh
$ g add awesome /home/user/directory/dir/awesome
$ g list
# Output:
@@ -25,31 +29,26 @@ $ g rm awesome
$ g list
# Output:
# anotherawesome => /home/user/directory/anotherawesome
-#+END_SRC
+```
I guess that the commands above are quite self-explanatory.
-** Install
-
-Just place the =g.sh= and the =gcompletion.sh= files wherever you want and then
-add a =source= command for both of the files in the =.bashrc= file.
-
-** GNU Emacs
+## Install
-I have also created a package for GNU Emacs and it is available on my [[https://github.com/mssola/dotfiles/blob/master/.emacs.d/lisp/g.el][dotfiles]]
-project.
+Just place the `g.sh` and the `gcompletion.sh` files wherever you want and then
+add a `source` command for both of the files in the `.bashrc` file.
-** Contributing
+## Contributing
-Read the [[./CONTRIBUTING.org][CONTRIBUTING.org]] file.
+Read the [CONTRIBUTING.org](./CONTRIBUTING.org) file.
-** [[https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small][Changelog]]
+## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small)
-Read the [[./CHANGELOG.org][CHANGELOG.org]] file.
+Read the [CHANGELOG.org](./CHANGELOG.org) file.
-** Legal stuff
+## License
-#+BEGIN_SRC text
+```txt
Copyright (C) 2013-2023 Miquel Sabaté Solà <mikisabate@gmail.com>
This program is free software: you can redistribute it and/or modify
@@ -64,4 +63,4 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
-#+END_SRC
+```