Skip to content

maximbircu/friday

Repository files navigation

License

Friday (My personal engineering assistant)

Friday is a simple Kotlin console application containing some dummy commands, and the required infrastructure to add more useful ones.

Usage

Check out www.maximbircu.com to learn more details about Friday.

  1. Fork the repo
  2. Run ./install.bash
  3. To generate a class for a new command run friday new-command

Check out https://ajalt.github.io/clikt/ - to learn more how to write commands and use command line arguments.

Contribution rules:

  1. Make sure there is a GitHub issue describing the changes you want to contribute with. (Add one if needed)
  2. Submit a PR just in case you:
  • Fixed the bug or implement the new feature properly;
  • Covered all code with unit tests; (No unit test - to be added later)
  • Updated the changelog file;
  • Updated the README.md (If needed);

License

Copyright 2021 Maxim Bîrcu

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

Friday (My personal engineering assistant)

Resources

License

Stars

Watchers

Forks