Updated Readme and added public repo to help output

This commit is contained in:
rexy712 2019-07-22 13:50:46 -07:00
parent c0abcee00b
commit 72891834c2
2 changed files with 21 additions and 9 deletions

View File

@ -6,15 +6,26 @@ Currently I can only confirm it runs on a linux system and I have no desire to e
To keep compatability with both GNU cat and lolcat, I wanted all command line options from both to either be implemented or ignored. However there are a few conflicts between the two, namely -s -t and -v. For these I will be implementing the GNU cat functionality. To keep compatability with both GNU cat and lolcat, I wanted all command line options from both to either be implemented or ignored. However there are a few conflicts between the two, namely -s -t and -v. For these I will be implementing the GNU cat functionality.
Current version is 0.1a as of writing this, so if the version is much newer, remind me to update this readme :) Current version is 1.1 as of writing this, so if the version is much newer, remind me to update this readme :)
![alt text](https://i.postimg.cc/1tYmJzxd/roflcat-usage.png "Screenshot of --help output") ![alt text](https://i.postimg.cc/0Qk6k34j/roflcat-usage.png "Screenshot of --help output")
## Dependencies
ncurses
cmake
## Building ## Building
There is no release right now. There is only the debug build which will produce an executable called 'tester'. ```
To build just run `make`. mkdir build
cd build
cmake ..
make
```
## Installing ## Installing
I would not recommend installing at this time. There is no install target in the makefile. From within the build directory:
```
make install
```
## More Screenshots ## More Screenshots
Some test outputs on a file filled with laughing cat emojis Some test outputs on a file filled with laughing cat emojis

View File

@ -94,6 +94,7 @@ constexpr void print_usage(Printer&& p){
p.print(L'\n'); p.print(L'\n');
} }
p.print(L"\nroflcat Copyright (C) 2019 rexy712\n"); p.print(L"\nroflcat Copyright (C) 2019 rexy712\n");
p.print(L"Source code can be found at https://gitlab.com/rexy712/roflcat\n");
p.print(L"This program comes with ABSOLUTELY NO WARRANTY\n"); p.print(L"This program comes with ABSOLUTELY NO WARRANTY\n");
p.print(L"This is free software, and you are welcome to redistribute it\n"); p.print(L"This is free software, and you are welcome to redistribute it\n");
p.print(L"under certain conditions; see the GNU GPLv3 for details.\n"); p.print(L"under certain conditions; see the GNU GPLv3 for details.\n");