readme v0.1
This commit is contained in:
parent
4ce389d141
commit
ef3a6ff86b
33
README.md
33
README.md
|
@ -9,23 +9,24 @@ Installing a single component is currently not supported.
|
|||
|
||||
## Target
|
||||
|
||||
1. TextRenderer translate the string from Terminal to a bitmap array.
|
||||
the bitmap will output in the terminal and store in shared memory.
|
||||
TextRender build exports an interface target TextRender::TextRender. Link against
|
||||
it will add the proper include path and all necessary capablities to the
|
||||
resulting binary.
|
||||
|
||||
## How to use the program
|
||||
This means that if TextRender has been installed on the Project Path, it
|
||||
should be enough to do.
|
||||
|
||||
1. You must install catch2 in your computer.
|
||||
the catch2 website is https://github.com/catchorg/Catch2
|
||||
|
||||
If you cannot install Catch2 from a package manager (e.g. Ubuntu 16.04 provides catch only in version 1.2.0)
|
||||
you might want to install it from the repository instead. Assuming you have enough rights, you can just
|
||||
install it to the default location, like so:
|
||||
~~~~
|
||||
$ git clone https://github.com/catchorg/Catch2.git
|
||||
$ cd Catch2
|
||||
$ cmake -Bbuild -H. -DBUILD_TESTING=OFF
|
||||
$ sudo cmake --build build/ --target install
|
||||
|
||||
2. Debug
|
||||
...
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
mkdir build
|
||||
cd build
|
||||
cmake ..
|
||||
make
|
||||
|
||||
## Example
|
||||
|
||||
translate()
|
||||
|
|
Loading…
Reference in New Issue