Updated README.md

* Added preview image
* Added sections Build and Issues
This commit is contained in:
KLuka 2015-03-12 15:28:14 +01:00
parent 252dbaed88
commit 1fc7a14c19
2 changed files with 33 additions and 1 deletions

View file

@ -6,7 +6,8 @@ This is unofficial fork of project **shellinabox**. Fork was created because
original project is not maintained anymore and we cannot contact original original project is not maintained anymore and we cannot contact original
repository owners. repository owners.
Our aim is to continue with maintanince of shellinabox project. Our aim is to continue with maintanince of shellinabox project. For list of
recent changes please see [CHANGELOG.md](/CHANGELOG.md).
If you have any questions, issues or patches, please fell free to submit pull If you have any questions, issues or patches, please fell free to submit pull
request or report an issue. You can also drop an email to original project request or report an issue. You can also drop an email to original project
@ -22,8 +23,39 @@ tools to a web based terminal emulator. This emulator is accessible to any
JavaScript and CSS enabled web browser and does not require any additional JavaScript and CSS enabled web browser and does not require any additional
browser plugins. browser plugins.
![Shell In A Box preview](/misc/preview.png?raw=true)
More information: More information:
* [Official site](https://code.google.com/p/shellinabox) * [Official site](https://code.google.com/p/shellinabox)
* [Official wiki](https://code.google.com/p/shellinabox/wiki/shellinaboxd_man) * [Official wiki](https://code.google.com/p/shellinabox/wiki/shellinaboxd_man)
Build
-----------------
For building **shellinabox** from source on Ubuntu use commands listed below.
1. Install dependencies
```
apt-get install git dpkg-dev debhelper autotools-dev libssl-dev libpam0g-dev zlib1g-dev libssl1.0.0 libpam0g
```
2. Clone sources and move to project directory
```
git clone https://github.com/shellinabox/shellinabox.git && cd shellinabox
```
3. Run autotools in project directory
```
autoreconf -i
```
4. Configure and make in project directory
```
./configure && make
```
Issues
-----------------
All reported issues were imported from [Google Code Project Issues](https://code.google.com/p/shellinabox/issues/list).
You can report new issues here, but please try to reproduce them on our sources.

BIN
misc/preview.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB