From 57d49ddffa09ba524e2a344339ed0513c9fc6c20 Mon Sep 17 00:00:00 2001 From: Miquel Sabaté Solà Date: Mon, 2 Jan 2023 12:53:26 +0100 Subject: ci: travis -> github MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Miquel Sabaté Solà --- .github/workflows/ci.yml | 16 ++++++++++++ .travis.yml | 7 ----- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++ README.org | 67 ------------------------------------------------ 4 files changed, 82 insertions(+), 74 deletions(-) create mode 100644 .github/workflows/ci.yml delete mode 100644 .travis.yml create mode 100644 README.md delete mode 100644 README.org 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.md b/README.md new file mode 100644 index 0000000..ab30559 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +

+ Build Status for main branch + License GPL 3 +

+ +--- + +This repository holds a very humble and simple script that handles shortcuts of +bash paths. For example: + +``` sh +$ g awesome +# instead of ... +$ cd /home/user/directory/dir/awesome +``` + +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: + +``` sh +$ g add awesome /home/user/directory/dir/awesome +$ g list +# Output: +# awesome => /home/user/directory/dir/awesome +$ cd /home/user/directory/anotherawesome +$ g add anotherawesomedir +$ g rm awesome +$ g list +# Output: +# anotherawesome => /home/user/directory/anotherawesome +``` + +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. + +## Contributing + +Read the [CONTRIBUTING.org](./CONTRIBUTING.org) file. + +## [Changelog](https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small) + +Read the [CHANGELOG.org](./CHANGELOG.org) file. + +## License + +```txt +Copyright (C) 2013-2023 Miquel Sabaté Solà + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +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 . +``` diff --git a/README.org b/README.org deleted file mode 100644 index 270fdb7..0000000 --- a/README.org +++ /dev/null @@ -1,67 +0,0 @@ -* Yeah! just one letter ! -[[https://travis-ci.org/mssola/g][https://travis-ci.org/mssola/g.svg?branch=master]] - -This repository holds a very humble and simple script that handles shortcuts of -bash paths. For example: - -#+BEGIN_SRC bash -$ 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 -$ g add awesome /home/user/directory/dir/awesome -$ g list -# Output: -# awesome => /home/user/directory/dir/awesome -$ cd /home/user/directory/anotherawesome -$ g add anotherawesomedir -$ 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 - -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. - -** Contributing - -Read the [[./CONTRIBUTING.org][CONTRIBUTING.org]] file. - -** [[https://pbs.twimg.com/media/DJDYCcLXcAA_eIo?format=jpg&name=small][Changelog]] - -Read the [[./CHANGELOG.org][CHANGELOG.org]] file. - -** Legal stuff - -#+BEGIN_SRC text -Copyright (C) 2013-2023 Miquel Sabaté Solà - -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. - -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -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 . -#+END_SRC -- cgit v1.2.3