Update README.md

This commit is contained in:
Emre Akkaya 2016-04-15 11:06:41 +03:00
parent 5ec5598177
commit 72a848bafc

View file

@ -1,27 +1,57 @@
# README #
# ahenk
This README would normally document whatever steps are necessary to get your application up and running.
**Lider Ahenk** is an open source project which provides solutions to manage, monitor and audit unlimited number of different systems and users on a network.
Ahenk is a Linux agent written in Python which enables Lider to manage & monitor clients remotely.
### What is this repository for? ###
## Documentation
* Quick summary
* Version
* See [Ahenk wiki](https://github.com/Pardus-Kurumsal/ahenk/wiki) to get started!
* See how to [setup development environment](https://github.com/Pardus-Kurumsal/ahenk/wiki/01.-Setup-Development-Environment)
* Learn how to [run](https://github.com/Pardus-Kurumsal/ahenk/wiki/02.-Running) ahenk.
* Create [Ahenk distribution](https://github.com/Pardus-Kurumsal/ahenk/wiki/03.-Ahenk-Distribution) as .deb package
### How can I build and create deb file ? ###
## Contribution
Clone project and go to ahenk project folder, run command below
We encourage contributions to the project. To contribute:
$ dpkg-buildpackage
* Fork the project and create a new bug or feature branch.
* Make your commits with clean, understandable comments
* Perform a pull request
### How do I get set up? ###
## Other Lider Ahenk Projects
* Summary of set up
* Configuration
* Dependencies
* How to run tests
* [Lider](https://github.com/Pardus-Kurumsal/lider): Business layer running on Karaf container.
* [Lider Console](https://github.com/Pardus-Kurumsal/lider-console): Administration console built as Eclipse RCP project.
* [Lider Ahenk Installer](https://github.com/Pardus-Kurumsal/lider-ahenk-installer): Installation wizard for Ahenk and Lider (and also its LDAP, database, XMPP servers).
* [Lider Ahenk Archetype](https://github.com/Pardus-Kurumsal/lider-ahenk-archetype): Maven archetype for easy plugin development.
### Contribution guidelines ###
## Changelog
* Writing tests
* Other guidelines
See [changelog](https://github.com/Pardus-Kurumsal/lider/wiki/Changelog) to learn what we have been up to.
## Roadmap
#### Today
* 30+ plugins
* Linux agent service written in Python
* Administration console built as Eclipse RCP
* Open sourced, easy to access and setup, stable Lider Ahenk v1.0.0
#### 2016
* Scalable infrastructure suitable for million+ users & systems
* 10+ new plugins (such as file distribution via torrent, remote installation)
* New reporting module & dashboard
#### 2017
* Agents for Windows and mobile platforms
* Platform-independent administration console
* Inventory scan & management
* Printer management
## License
Lider Ahenk and its sub projects are licensed under the [LGPL v3](https://github.com/Pardus-Kurumsal/lider/blob/master/LICENSE).