Skip to content

Commit 9ab2a5f

Browse files
committed
readme changes, various updates
1 parent e946dd4 commit 9ab2a5f

File tree

3 files changed

+107
-1
lines changed

3 files changed

+107
-1
lines changed

.gitignore

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
2+
# Created by https://www.gitignore.io/api/nim,code,c
3+
4+
### Nim ###
5+
nimcache/
6+
7+
8+
### Code ###
9+
# Visual Studio Code - https://code.visualstudio.com/
10+
.settings/
11+
.vscode/
12+
tsconfig.json
13+
jsconfig.json
14+
15+
16+
### C ###
17+
# Prerequisites
18+
*.d
19+
20+
# Object files
21+
*.o
22+
*.ko
23+
*.obj
24+
*.elf
25+
26+
# Linker output
27+
*.ilk
28+
*.map
29+
*.exp
30+
31+
# Precompiled Headers
32+
*.gch
33+
*.pch
34+
35+
# Libraries
36+
*.lib
37+
*.a
38+
*.la
39+
*.lo
40+
41+
# Shared objects (inc. Windows DLLs)
42+
*.dll
43+
*.so
44+
*.so.*
45+
*.dylib
46+
47+
# Executables
48+
*.exe
49+
*.out
50+
*.app
51+
*.i*86
52+
*.x86_64
53+
*.hex
54+
55+
# Debug files
56+
*.dSYM/
57+
*.su
58+
*.idb
59+
*.pdb
60+
61+
# Kernel Module Compile Results
62+
*.mod*
63+
*.cmd
64+
modules.order
65+
Module.symvers
66+
Mkfile.old
67+
dkms.conf
68+
69+
# End of https://www.gitignore.io/api/nim,code,c

README.md

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,38 @@
11
# tinytwitch
2-
A very tiny twitch.tv chat viewer
2+
tinytwitch is a twitch chat viewer with not many features (no emotes, you can only view chat, etc) but a very small footprint
3+
(less than 1.5mb ram and 0.02% cpu usage when connected to the top 10 streamer's chats at time of writing)
4+
5+
This makes it much more lightweight than using a browser and much more simple than using an IRC client just for twitch
6+
7+
If you're just looking for the downloads, [click here](https://github.com/smt923/tinytwitch/releases)
8+
9+
![tinytwitch](http://i.imgur.com/t6B0Syj.png)
10+
11+
## Usage
12+
Either run the program with the streamer's chatrooms as arguments:
13+
```
14+
tinytwitch.exe bobross summit1g lirik
15+
```
16+
Or run the program and it will prompt you to enter streamers in the same format:
17+
```
18+
>tinytwitch.exe
19+
Type the usernames of the channels to join, seperated by a space:
20+
bobross summit1g lirik
21+
```
22+
You can of course just enter a single channel
23+
24+
## What is it for?
25+
This was mostly made for fun and to test the awesome language it's made in, [Nim](http://nim-lang.org/)
26+
You'll probably immediately know if you have use for this or not, if you don't feel like
27+
leaving a resource hog browser running but still want your chat up, or maybe you want to leave a friend's/streamer you moderate's
28+
chat up while playing a game and lanuch a browser when you need to step in and moderate
29+
30+
## Building
31+
You'll need [Nim](http://nim-lang.org/) to build the program your self, simply running
32+
```
33+
$ nimble install
34+
```
35+
should install the program, or it can be built simply with
36+
```
37+
$ nim c -d:release tinytwitch.nim
38+
```

tinytwitch.nimble

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ author = "smt"
55
description = "Very simple, very lightweight Twitch.tv chat viewer"
66
license = "MIT"
77
bin = @["tinytwitch"]
8+
skipExt = @["nim"]
89

910
# Dependencies
1011

0 commit comments

Comments
 (0)