mirror of
https://github.com/ascii-boxes/boxes.git
synced 2024-12-13 10:20:37 +01:00
Update README.md
This commit is contained in:
parent
4daa0f4f46
commit
273207893c
72
README.md
72
README.md
@ -4,39 +4,17 @@
|
|||||||
|
|
||||||
**Command line ASCII boxes unlimited!**
|
**Command line ASCII boxes unlimited!**
|
||||||
|
|
||||||
[Boxes](https://boxes.thomasjensen.com/) is a command line
|
[Boxes](https://boxes.thomasjensen.com/) is a command line filter program which draws ASCII
|
||||||
[filter program](https://boxes.thomasjensen.com/docs/filters.html) that draws ASCII art boxes
|
art boxes around your input text ([examples](https://boxes.thomasjensen.com/examples.html)).
|
||||||
around your input text ([examples](https://boxes.thomasjensen.com/examples.html)).
|
|
||||||
|
|
||||||
![example boxes](README-0.gif)
|
![example boxes](README-0.gif)
|
||||||
|
|
||||||
For more information, please visit [the website](https://boxes.thomasjensen.com/).
|
For more information, please visit [the website](https://boxes.thomasjensen.com/).
|
||||||
|
|
||||||
## Status
|
## Download
|
||||||
|
|
||||||
*Boxes* is **stable**.
|
The recommended way is to install *boxes* via your package manager. But many ways exist
|
||||||
|
to get *boxes* onto your machine, [details here](https://boxes.thomasjensen.com/download.html).
|
||||||
It has been around since 1999, and has since been included in several
|
|
||||||
Linux distributions and, lately, even
|
|
||||||
[Windows 10](https://boxes.thomasjensen.com/2016/08/boxes-part-of-windows10), via its Ubuntu subsystem.
|
|
||||||
Its source code is quite portable, and so, *boxes* has been made to run on a wide range of
|
|
||||||
platforms, from Windows PCs to Netgear routers.
|
|
||||||
|
|
||||||
*Boxes* has matured, and is thusly no longer being actively developed. But contributors can be sure
|
|
||||||
that their pull requests are promptly reviewed and merged into the main code base.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
Boxes is free software under the GNU General Public License, version 2
|
|
||||||
([GPLv2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)).
|
|
||||||
|
|
||||||
## Development
|
|
||||||
|
|
||||||
The website has information on [building from source](https://boxes.thomasjensen.com/build.html),
|
|
||||||
[testing](https://boxes.thomasjensen.com/testing.html), and
|
|
||||||
[contributing](https://boxes.thomasjensen.com/contributing.html) to the source code.<br/>
|
|
||||||
*Boxes* has received support from many [contributors](https://boxes.thomasjensen.com/contributing.html#contributors)
|
|
||||||
over the years, and continues to benefit greatly from contributions. Many thanks for that!
|
|
||||||
|
|
||||||
## Running it
|
## Running it
|
||||||
|
|
||||||
@ -48,22 +26,52 @@ It should give you something like that:
|
|||||||
/*******/
|
/*******/
|
||||||
|
|
||||||
Type `boxes -l` to get a long list of box designs to use. Detailed usage information is in the
|
Type `boxes -l` to get a long list of box designs to use. Detailed usage information is in the
|
||||||
manual page and on the website. Consider tying
|
[manual page](https://boxes.thomasjensen.com/docs/boxes-man-1.html) and on the website. Consider
|
||||||
*boxes* to your editor, so that it can be invoked by a simple keypress.
|
[tying *boxes* to your editor](https://boxes.thomasjensen.com/docs/install.html),
|
||||||
|
so that it can be invoked by a simple keypress.
|
||||||
|
|
||||||
|
## Status
|
||||||
|
|
||||||
|
*Boxes* is **stable**.
|
||||||
|
|
||||||
|
It has been around since 1999, and is still available and kept current in many package managers
|
||||||
|
(apt, rpm, choco, brew, just to name a few). Its source code is quite portable, and so, *boxes*
|
||||||
|
has been made to run on a wide range of platforms, from Windows PCs to Netgear routers.
|
||||||
|
|
||||||
|
*Boxes* has matured, and is thusly no longer being actively developed. But contributors can be sure
|
||||||
|
that their pull requests are promptly reviewed and merged into the main code base.
|
||||||
|
|
||||||
|
Update 2021: In 2021, the original author has turned to *boxes* again in order to implement all
|
||||||
|
open issues, including full multi-byte character set support. This is still ongoing, but there
|
||||||
|
have already been two new releases with significant new functionality.
|
||||||
|
|
||||||
|
## Development
|
||||||
|
|
||||||
|
The website has information on [building from source](https://boxes.thomasjensen.com/build.html),
|
||||||
|
[testing](https://boxes.thomasjensen.com/testing.html), and
|
||||||
|
[contributing](https://boxes.thomasjensen.com/contributing.html) to the source code.<br/>
|
||||||
|
*Boxes* has received support from many [contributors](https://boxes.thomasjensen.com/contributing.html#contributors)
|
||||||
|
over the years, and continues to benefit greatly from contributions. Many thanks for that!
|
||||||
|
|
||||||
## Custom box designs
|
## Custom box designs
|
||||||
|
|
||||||
You can define [your own box designs](https://boxes.thomasjensen.com/docs/)!
|
You can define [your own box designs](https://boxes.thomasjensen.com/docs/)!
|
||||||
|
|
||||||
We appreciate the creative new box designs that you craft for *boxes*.
|
We appreciate the creative new box designs that you craft for *boxes*.
|
||||||
Please feel free to submit them in the form of pull requests on
|
If you think that others should have your box designs, please feel free to submit them in the
|
||||||
|
form of pull requests on
|
||||||
[boxes-config](https://github.com/ascii-boxes/boxes/blob/master/boxes-config),
|
[boxes-config](https://github.com/ascii-boxes/boxes/blob/master/boxes-config),
|
||||||
and they may make it into the next release!
|
and they may make it into the next release!
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Boxes is free software under the GNU General Public License, version 2
|
||||||
|
([GPLv2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)).
|
||||||
|
|
||||||
```
|
```
|
||||||
_________________________
|
_________________________
|
||||||
/\ \
|
/\ \
|
||||||
\_| Thank you for |
|
\_| Thank you for |
|
||||||
| using Boxes! |
|
| using Boxes! |
|
||||||
| _____________________|_
|
| _____________________|_
|
||||||
\_/______________________/
|
\_/______________________/
|
||||||
|
Loading…
Reference in New Issue
Block a user