extern/boxes
1
0
Fork 0
mirror of https://github.com/ascii-boxes/boxes.git synced 2025-06-19 17:28:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

Streamline README.md

Browse Source
This commit is contained in:
Thomas Jensen 2017-03-15 21:57:25 +01:00 committed by GitHub
parent f6bae3493d
commit 8aee647bf2
1 changed files with 36 additions and 111 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

147
README.md
View File

@ -1,99 +1,42 @@
[![Build Status](https://travis-ci.org/ascii-boxes/boxes.svg?branch=master)](https://travis-ci.org/ascii-boxes/boxes)
# boxes
```
_.
| | ____ ____
| |__ ____ ___ ___ ____ ______ ___ __ /_ | /_ |
| __ \ / _ \ \ \/ / _/ __ \ / ___/ \ \/ / | | | |
| \_\ \ ( <_> ) > < \ ___/ \___ \ \ / | | | |
|___ / \____/ /__/\_ \ \___ > /____ > \_/ |___| /\ |___|
\/ \/ \/ \/ \/
**Command line ASCII boxes unlimited!**
draws all kinds of boxes around your text (in ASCII art)
[Boxes](http://boxes.thomasjensen.com/) is a command line
[filter program](http://boxes.thomasjensen.com/docs/filters.html) that draws ASCII art boxes
around your input text ([examples](http://boxes.thomasjensen.com/examples.html)).
[stable release 1.1.2]
```
For more information, please visit [the website](http://boxes.thomasjensen.com/).
## Status
###GETTING IT
*Boxes* is **stable**.
http://boxes.thomasjensen.com/
It has been around since 1999, and has since been included in several
Linux distributions and, lately, even
[Windows 10](http://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 is free software under the GNU General Public License (GNU GPL),
version 2. See LICENSE file or
http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
*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
###COMPILING IT
Boxes is free software under the GNU General Public License, version 2
([GPLv2](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html)).
Skip this section if you got yourself a binary distribution. Note,
however, that the location of the system-wide config file can only be
changed using the source distribution, because its path is compiled in.
## Development
1. Unpack the archive.
2. Edit the top level *Makefile* and change the value of `GLOBALCONF` to
whereever you want the system-wide config file to reside. Note that
each user may have his/her own config file in *$HOME/.boxes*.
Also note that the value of `GLOBALCONF` is a full file name. It does
**not** specify a directory into which to copy the config file.
The website has information on [building from source](http://boxes.thomasjensen.com/build.html),
[testing](http://boxes.thomasjensen.com/testing.html), and
[contributing](http://boxes.thomasjensen.com/contributing.html) to the source code.<br/>
*Boxes* has received support from many [contributors](http://boxes.thomasjensen.com/contributing.html#contributors)
over the years, and continues to benefit greatly from contributions. Many thanks for that!
3. If you are on DEC/OSF, edit *src/regexp/Makefile*, and add
`-D_ANSI_C_SOURCE` to the `CFLAGS` definition.
4. Type `make` in the top level directory.<br/>
This should leave you with the binary in the *src* directory.
The boxes development platform is intel/linux (SLES). If you are on a
different platform and somehow manage to materialize a binary, please
send it to the author (boxes at thomasjensen.com), so it can be posted on
the boxes home page. Boxes is generally very easy to port, because it
uses only a small set of instructions and is comformant to the ANSI C
standard.
For a small collection of frequently asked questions, visit the
[compilation FAQ](http://boxes.thomasjensen.com/docs/faq.html#q5)
on the boxes website.
###INSTALLING IT
1. Basic installation
- If you are installing a BINARY distribution:
- Copy *boxes.1* to an appropriate manual page directory.
- Copy *boxes-config* to */usr/share/boxes*.
Note that */usr/share/boxes* is the name of the file,
and **not** the name of a directory into which to copy the file.
So, the name of the config file is changed from *boxes-config*
to just *boxes*.
- Copy the executable to a location which is in your path.<br/>
*Example* (as root):<pre>cp boxes.1 /usr/share/man/man1
cp boxes-config /usr/share/boxes
cp boxes /usr/bin</pre>
- If you are installing a SOURCE distribution:
- Copy *doc/boxes.1* to an appropriate manual page directory.
- Copy *boxes-config* to the location specified in the Makefile
as being the name of the system-wide boxes config file.
Note that the value of `GLOBALCONF` is the name of the file,
and **not** the name of a directory into which to copy the file.
So, the name of the config file is changed from *boxes-config*
to just *boxes*.
- Copy *src/boxes* (the binary) to a location which is in your path.<br/>
*Example* (as root):<pre>cp doc/boxes.1 /usr/share/man/man1
cp boxes-config /usr/share/boxes
cp src/boxes /usr/bin</pre>
2. If you want to make your own changes to the config file, copy the
system-wide config file into your home as *$HOME/.boxes*, then modify
it. Boxes will use *$HOME/.boxes* if it exists.
3. Integration into your text editor: Please see the
[editor integration page](http://boxes.thomasjensen.com/docs/install.html)
on the website.
It currently describes integration with vim, emacs, and jed, but
this list may grow as time goes by and people send how-tos.
###RUNNING IT
## Running it
Try if boxes works by typing `echo foo | boxes` on the command line.
It should give you something like that:
@ -102,42 +45,24 @@ It should give you something like that:
/* foo */
/*******/
Detailed usage information is in the manual page and a lot more can be
found on the website (see above). It is especially interesting to tie
boxes to your editor, so that it can be invoked by a simple keypress.
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
*boxes* to your editor, so that it can be invoked by a simple keypress.
## Custom box designs
###DEFINING YOUR OWN BOXES
You can define [your own box designs](http://boxes.thomasjensen.com/docs/)!
Any user may define his or her own box designs by creating a file called
*.boxes* in his or her home directory. The syntax of the config file is
explained on the boxes home page, along with several examples:
http://boxes.thomasjensen.com/docs/
###CONTACT
- For questions which the online documentation could not answer,
praise and general comments please feel free to email the author at
boxes at thomasjensen.com. Bug reports are especially appreciated,
but those should, like feature requests, be opened on Github.
- For questions particular to the binary you downloaded contact the
supplier of the binary listed on the download page.
- I appreciate the creative new box designs that you craft for boxes.
Please feel free to submit them in the form of pull requests on
*boxes-config*, and they may make it into the next release!
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
[boxes-config](https://github.com/ascii-boxes/boxes/blob/master/boxes-config),
and they may make it into the next release!
```
_________________________
/\ \
\_| Thank you for |
| using Boxes. Enjoy! |
\_| Thank you for |
| using Boxes! |
| _____________________|_
\_/______________________/
```
10/19/2012
<tt>EOF</tt>