Skip to content

Commit

Permalink
trimmed the readme to remove clutter.
Browse files Browse the repository at this point in the history
  • Loading branch information
bengarrett committed May 25, 2024
1 parent 5fec5d6 commit ee1ee92
Showing 1 changed file with 29 additions and 50 deletions.
79 changes: 29 additions & 50 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Turn pieces of ANSI, ASCII, and NFO documents into HTML. RetroTxt is the browser

---

#### Install from the [Chrome Store](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) ~ [Microsoft Addons](https://microsoftedge.microsoft.com/addons/detail/hmgfnpgcofcpkgkadekmjdicaaeopkog) ~ [Firefox Addons](https://addons.mozilla.org/en-US/firefox/addon/retrotxt)*
#### Install from, [the Chrome store](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) · [Microsoft addons](https://microsoftedge.microsoft.com/addons/detail/hmgfnpgcofcpkgkadekmjdicaaeopkog) · [Firefox addons](https://addons.mozilla.org/en-US/firefox/addon/retrotxt)

![RetroTxt showcase](../docs/assets/showcase-clean.png)

Expand All @@ -39,71 +39,50 @@ From Commodore, Atari, Apple, Tandy, and more

#### Support RetroTxt, why not buy me a coffee? ☕ Use [Ko-fi](https://ko-fi.com/codebyben) or [Buy Me a Coffee](https://www.buymeacoffee.com/4rtEGvUIY), thank you!

## Install · suitable for all compatible browsers
## [Install](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) · suitable for all compatible browsers

### [Chrome](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) · [Edge](https://microsoftedge.microsoft.com/addons/detail/hmgfnpgcofcpkgkadekmjdicaaeopkog)
### · [Chrome store](https://chrome.google.com/webstore/detail/retrotxt/gkjkgilckngllkopkogcaiojfajanahn) · [Edge addons](https://microsoftedge.microsoft.com/addons/detail/hmgfnpgcofcpkgkadekmjdicaaeopkog)

### [Or use the source code](https://docs.retrotxt.com/src/)
### · [Or use the source code](https://docs.retrotxt.com/src/)

## A legacy edition is available for [Firefox](https://addons.mozilla.org/en-US/firefox/addon/retrotxt) *
### · [Firefox](https://addons.mozilla.org/en-US/firefox/addon/retrotxt), discontinued

Firefox support will resume once its [Manifest version 3](https://docs.retrotxt.com/src/mv3/) implementation [supports service workers](https://bugzilla.mozilla.org/show_bug.cgi?id=1573659).
Firefox support will resume once its [Manifest version 3](https://docs.retrotxt.com/src/mv3/) implementation supports [service workers](https://bugzilla.mozilla.org/show_bug.cgi?id=1573659), 5 years and waiting.

#### [Firefox legacy source code](https://github.com/bengarrett/RetroTxt/tree/manifest-v2)
## [Privacy](https://docs.retrotxt.com/privacy)

## Requirements
RetroTxt does not collect or transmit any data created by your web browser. All Extension data is stored locally on your computer using the [storage.local API](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/local).

**Chrome or Edge 106** (or a compatible browser such as Arc, Brave or Vivaldi)

**Or newer browsers**

## Privacy

#### RetroTxt does not collect or transmit any data created by your web browser

All Extension data is stored locally on your computer using the [storage.local API](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/local).

#### [RetroTxt Privacy](https://docs.retrotxt.com/privacy)

## License
## [License, LGPL](https://choosealicense.com/licenses/lgpl-3.0)

![GitHub](https://img.shields.io/github/license/bengarrett/retrotxt?style=flat-square)

#### An important note about the software license

RetroTxt uses the **[GNU Lesser General Public License v3.0](https://choosealicense.com/licenses/lgpl-3.0)**

**The license does not cover the included fonts**. You should read each font license in the [`fonts/`](../fonts/) subdirectory before redistribution, as some of the authors do not permit the sale or modification of their fonts or collections.
**An important note about the software license, the license does not cover the included fonts**. You should read each font license in the [`fonts/`](../fonts/) subdirectory before redistribution, as some of the authors do not permit the sale or modification of their fonts or collections.

## Credits

RetroTxt by [Ben Garrett](https://devtidbits.com/ben-garrett) ([gmail](mailto:[email protected]))

RetroTxt ANSI logo by [Zeus II](https://twitter.com/Zeus_II)

Fonts from

- [_The Ultimate Oldschool PC Font Pack_](https://int10h.org/oldschool-pc-fonts) by Viler
- [_Retro Computer Fonts_](https://www.kreativekorp.com/software/fonts/index.shtml#retro) by Kreative Korp
- [_Typography articles_](https://damieng.com/blog/category/Typography/) by Damien Guard
RetroTxt by [Ben Garrett](https://devtidbits.com/ben-garrett), @ [mail](mailto:[email protected]).
ANSI logo by [Zeus II](https://twitter.com/Zeus_II). CSS framework by [Bulma](https://bulma.io). Options icons by [Google Material Design](https://material.io/resources/icons).

* [_Atari Classic TrueType Fonts_](http://members.bitstream.net/marksim/atarimac/fonts.html) by Mark L. Simonson
* [_Atari ST 8x16 System_](https://www.dafont.com/atari-st-8x16-system-font.font) by divVerent
* [_C64 TrueType_](https://style64.org/c64-truetype) by Style
* [_Cascadia_](https://github.com/microsoft/cascadia-code) by Microsoft
* [_IBM 3270_](https://github.com/rbanffy/3270font) by Ricardo Banffy
* [_Intel One Mono_](https://github.com/intel/intel-one-mono) by Intel Corp.
* [_Mona_](https://monafont.sourceforge.net/index-e.html) in the public domain
* [_MSX_](http://www.ateijelo.com/blog/2016/09/13/making-an-msx-font) by Andy Teijelo Pérez
* [_Multi Platform Fonts_](https://github.com/rewtnull/amigafonts) by TrueSchool Ascii
* [_Plex_](https://github.com/IBM/plex) by IBM Corp.
* [_Spleen_](https://github.com/fcambus/spleen) by Frederic Cambus
* [_Unscii_](http://viznut.fi/unscii/) by Viznut
Fonts from,

CSS framework by [Bulma](https://bulma.io)
- [_The Ultimate Oldschool PC Font Pack_](https://int10h.org/oldschool-pc-fonts) by Viler.
- [_Retro Computer Fonts_](https://www.kreativekorp.com/software/fonts/index.shtml#retro) by Kreative Korp.
- [_Typography articles_](https://damieng.com/blog/category/Typography/) by Damien Guard.

Options icons by [Google Material Design](https://material.io/resources/icons)
[_Atari Classic TrueType Fonts_](http://members.bitstream.net/marksim/atarimac/fonts.html) by Mark L. Simonson.
[_Atari ST 8x16 System_](https://www.dafont.com/atari-st-8x16-system-font.font) by divVerent.
[_C64 TrueType_](https://style64.org/c64-truetype) by Style.
[_Cascadia_](https://github.com/microsoft/cascadia-code) by Microsoft.
[_IBM 3270_](https://github.com/rbanffy/3270font) by Ricardo Banffy.
[_Intel One Mono_](https://github.com/intel/intel-one-mono) by Intel Corp.
[_Mona_](https://monafont.sourceforge.net/index-e.html) in the public domain.
[_MSX_](http://www.ateijelo.com/blog/2016/09/13/making-an-msx-font) by Andy Teijelo Pérez.
[_Multi Platform Fonts_](https://github.com/rewtnull/amigafonts) by TrueSchool Ascii.
[_Plex_](https://github.com/IBM/plex) by IBM Corp.
[_Spleen_](https://github.com/fcambus/spleen) by Frederic Cambus.
[_Unscii_](http://viznut.fi/unscii/) by Viznut.

---

### [Also available is Retrotxt for the terminal](https://github.com/bengarrett/retrotxtgo), an app to handle legacy, code page text files in a modern shell.
#### Also available, [Retrotxt for the terminal](https://github.com/bengarrett/retrotxtgo)! An app to handle legacy, code page text files in a modern shell.

0 comments on commit ee1ee92

Please sign in to comment.