README.md

system updater

Automatically update your tos environment when a new system is available
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Installing is as easy as the following (make sure the tos repo is in your pacman.conf file)

pacman -Syu system-updater

Installation

1. Clone the system-updater

git clone https://github.com/ODEX-TOS/system-updater.git

2. Run the updater

system-update # this will scan your system and perform a full upgrade to the latest tos version

Make sure you have a backup of your files incase they are lost. This updater will change your system

Usage

You can do more than just update your system. For example you can modify the /etc/system-updater.conf to match your system

Here is a short list of options you can perform

system-updater -i # Show your current tos version (--info)

system-updater -d # print what is new in the latest tos version (--difference)

system-updater -v # print the version of the tool (--version)

For more examples, please refer to the Documentation

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 MIT License. See LICENSE for more information.

Contact

F0xedb - tom@odex.be

Project Link: https://github.com/ODEX-TOS/system-updater

Acknowledgements

• ODEX-TOS