Skip to content
This repository was archived by the owner on Feb 4, 2024. It is now read-only.

Commit 963cb78

Browse files
committed
feat!: This is a new fork of picocom-ng
I have forked Nick Patavalis's original picocom repository [1] and started collecting fixes and adding features. See the README file for details. [1]: https://github.com/npat-efault/picocom
1 parent 17d7fae commit 963cb78

File tree

7 files changed

+51
-1125
lines changed

7 files changed

+51
-1125
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
11
*.o
22
*~
33
/picocom
4+
picocom.1
5+
picocom.1.html
6+
picocom.1.pdf

README.md

Lines changed: 43 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1-
# picocom
2-
Minimal dumb-terminal emulator
1+
![[Picocom][]](assets/picocom-logo.png)
32

4-
by Nick Patavalis ([email protected])
3+
[Picocom][] is a minimal dumb-terminal emulation program.
54

6-
The latest release can be downloaded from:
5+
[picocom]: https://picocom-ng.oddbit.com
76

8-
> https://github.com/npat-efault/picocom/releases
7+
## Origins
8+
9+
This is a fork of Nick Patavalis's [original picocom repository][nick],
10+
which was last updated in 2018. I have incorporated most of the pull
11+
requests from Nick's repository as well as several of the changes
12+
introduced by [Wolfram Sang][].
13+
14+
I am working on adding configuration file support, automated testing,
15+
and an automated release process. I am happy to accept bug reports and
16+
contributions (see [Contributing](#contributing), below).
17+
18+
[nick]: https://github.com/npat-efault/picocom
19+
[wolfram sang]: https://gitlab.com/wsakernel/picocom
20+
21+
## Overview
922

1023
As its name suggests, *picocom* is a minimal dumb-terminal emulation
1124
program. It is, in principle, very much like minicom, only it's "pico"
@@ -226,7 +239,7 @@ the following options:
226239

227240
sudo cp ./bash_completion/picocom /etc/bash_completion.d/
228241

229-
This will enable custom completion support for picocom, globaly
242+
This will enable custom completion support for picocom, globally
230243
(for all Bash-shell users).
231244

232245
*NOTICE:* If you have another version of picocom already installed,
@@ -240,7 +253,7 @@ the following options:
240253
automatically sourcing custom completion scripts.
241254

242255
2. If you want to automatically enable support *only for the current
243-
user*, you must arange for your user's `.bashrc` to source the
256+
user*, you must arrange for your user's `.bashrc` to source the
244257
custom completion script. There are, obviously, many ways to do
245258
this, so the following *is only a suggestion*:
246259

@@ -302,7 +315,7 @@ convenient place to keep stuff; so it doesn't need a login shell or a
302315
password.
303316

304317
Switch to the _termbox_ account and create a `bin` directory in its
305-
home-dir.
318+
home directory:
306319

307320
$ sudo su termbox
308321
$ cd ~
@@ -355,7 +368,7 @@ as the user's home directory, and the `-M` switch instructs it *not*
355368
to create the home-directory. We don't really need a home directory
356369
for the _ttyS0_ account, since picocom will not read or write any
357370
files; but we provide one, regardless, because *some* systems need a
358-
valid home-directory to cd-into on login (else they choke). We could
371+
valid home directory to `cd` into on login (else they choke). We could
359372
as well have used `/` as the home directory, or we could have let
360373
useradd create the usual `/home/ttyS0`.
361374

@@ -446,3 +459,24 @@ To see if your binary has been compiled with custom baudrate support,
446459
and / or if it has detected the `NO_CUSTOM_BAUD` variable, run it with
447460
the **--help** option, and take a look at the first few lines of
448461
output.
462+
463+
## Contributing
464+
465+
### Reporting bugs
466+
467+
Open bug reports in the [issue tracker for this repository][issues].
468+
469+
[issues]: https://github.com/picocom-ng/picocom/issues
470+
471+
### Contributing features
472+
473+
Please feel free to open pull requests for new features! Pull requests
474+
are expected to pass any automated checks, and must include both tests
475+
and documentation.
476+
477+
## Authors
478+
479+
Picocom was originally written by Nick Patavalis. This fork is
480+
maintained by Lars Kellogg-Stedman, <[email protected]>. For a complete
481+
list of contributors, see `git log`.
482+

assets/picocom-logo.png

6.27 KB
Loading

0 commit comments

Comments
 (0)