diff options
| author | Nick Gerace <nickagerace@gmail.com> | 2021-06-17 22:49:47 -0400 |
|---|---|---|
| committer | Nick Gerace <nickagerace@gmail.com> | 2021-06-17 22:58:48 -0400 |
| commit | 72ea1b30a33bceaaf3a27895e67adaa80096be33 (patch) | |
| tree | 5e8a10f59bae81a8c6d616eed922f075b4bac4c4 /docs/DEVELOPING.md | |
| parent | c3aef2868718e34d1d8f43af4ffa530a520a9a2d (diff) | |
| download | gfold-72ea1b30a33bceaaf3a27895e67adaa80096be33.zip | |
Move docs to their own directory and simplify README
Diffstat (limited to 'docs/DEVELOPING.md')
| -rw-r--r-- | docs/DEVELOPING.md | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/docs/DEVELOPING.md b/docs/DEVELOPING.md new file mode 100644 index 0000000..9884d04 --- /dev/null +++ b/docs/DEVELOPING.md @@ -0,0 +1,23 @@ +# Developing + +This document contains all tips, tricks and notes related to developing `gfold`. + +## Building + +On a compatible platform, execute the following commands: + +```sh +TEMP_TARGET=$HOME +cargo update +cargo +nightly fmt +cargo clippy +cargo test +cargo build --release +TEMP_BINARY=target/release/gfold +du -h $TEMP_BINARY | cut -f -1 +strip $TEMP_BINARY +du -h $TEMP_BINARY | cut -f -1 +time $TEMP_BINARY $TEMP_TARGET +``` + +> You can change `TEMP_TARGET` to a directory you'd like to target.
\ No newline at end of file |