Skip to content

Latest commit

 

History

History
210 lines (152 loc) · 6.37 KB

README.md

File metadata and controls

210 lines (152 loc) · 6.37 KB

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Yet Another Package-Manager

An unified package-manager with Github sync for saving your operating-system configuration
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgements

About The Project

Product Name Screen Shot

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need -- I think this is it.

Here's why:

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like creating a README from scratch
  • You should element DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have have contributed to expanding this template!

A list of commonly used resources that I find helpful are listed in the acknowledgements.

Built With

Technologies:

Libraries:

Getting Started

The following are the steps for install Yap. At the moment the application is called yapm because i'm waiting for Snap Store to grant me the alias yap

Prerequisites

  1. Install snap
sudo apt install snapd

Installation

  1. Install the application with snap
snap install yapm --edge --devmode

Usage

Start new instance and sync with GitHub

yapm start

Search packages

yapm search $packages

Install packages

yapm install $packages

Uninstall packages

yapm uninstall $packages

Update packages

yapm update $packages

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

Alessandro Mazzoli - @alessandro.py - [email protected]

Project Link: https://github.com/alemazzo/yap