-
Notifications
You must be signed in to change notification settings - Fork 26
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Docs: make installation section more prominent
- Loading branch information
Showing
5 changed files
with
58 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
# Installation | ||
|
||
TCFrame is a **header-only** C++ library, with a few helper shell scripts. In other words, you only need to get TCFrame's source code. | ||
|
||
## Getting the source code | ||
|
||
The recommended way is to **clone** the GitHub repository: **https://github.com/ia-toki/tcframe**. This way, you can just do `git pull` to fetch the latest updates. Alternatively, you can also **download** the latest release: **https://github.com/ia-toki/tcframe/releases**. | ||
|
||
Suppose that you cloned or downloaded TCFrame to `~/tcframe`. We will call this directory "TCFrame home". Confirm that this directory is correct by verifying that the `include` directory exists directly inside the TCFrame home. | ||
|
||
## Configure your environment | ||
|
||
Next, add the following lines to your `~/.bashrc`. This will set the environment variable `TCFRAME_HOME` to our TCFrame home directory, and make the `tcframe` command available everywhere. | ||
|
||
```sh | ||
export TCFRAME_HOME=~/tcframe | ||
alias tcframe=$TCFRAME_HOME/scripts/tcframe | ||
``` | ||
|
||
:::note | ||
|
||
If your `TCFRAME_HOME` contains space, you can escape it as follows: | ||
|
||
```sh | ||
export TCFRAME_HOME=~/path\ with\ space/tcframe | ||
alias tcframe='$TCFRAME_HOME/scripts/tcframe' | ||
``` | ||
|
||
::: | ||
|
||
## Verifying setup | ||
|
||
Restart your terminal session. Now, if you run | ||
|
||
``` | ||
tcframe | ||
``` | ||
|
||
You should see the following output | ||
|
||
``` | ||
usage: tcframe <command> | ||
Available commands: | ||
build Compile spec file into runner program | ||
version Print tcframe version | ||
``` | ||
|
||
You're good to go! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,4 +20,5 @@ | |
display: flex; | ||
align-items: center; | ||
justify-content: center; | ||
gap: 15px; | ||
} |