cadey
/
platypus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

This commit is contained in:
Victor Fernandes 2017-03-18 18:13:58 -04:00
parent eb322b2ddd
commit d3c6197b7e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -10,14 +10,14 @@
- `make [gcc | clang]` - `make [gcc | clang]`
- Default is to build both versions (this is an aftermath of testing behaviour from different compilers) - Default is to build both versions (this is an aftermath of testing behaviour from different compilers)
- It is safe to modify the default to either gcc or clang if you don't have one of them - It is safe to modify the default to either gcc or clang if you don't have one of them
- **NOTE: I haven't tested or created make targets for the scanner yet.**
### Windows ### Windows
#### Requires #### Requires
- `msvc` (tested under Visual Studio 2015 with Update 3, however VS2013 shouldn't behave abnormally either) - `msvc` (tested under Visual Studio 2015 with Update 3, however VS2013 shouldn't behave abnormally either, nor should 2017)
- Disable language extensions (use ANSI C) - Disable language extensions (use ANSI C)
--- ---
## Running ## Running
### Running the Buffer only
- *macOS/linux* - *macOS/linux*
- `$ ./buffer_<compiler> <file> [f | a | m] > <out_file>` - `$ ./buffer_<compiler> <file> [f | a | m] > <out_file>`
- *Windows* - *Windows*
@ -37,4 +37,4 @@ You can modify the initial capacity and increment factor defined in `platy_bt.c`
- Increment factor range for additive mode: `1 - 255`. (setting this to 0 implies fixed mode, regardless of the mode given in the command line) - Increment factor range for additive mode: `1 - 255`. (setting this to 0 implies fixed mode, regardless of the mode given in the command line)
- Initial capacity range (in bytes): `0 - 32767 (SHRT_MAX)` - Initial capacity range (in bytes): `0 - 32767 (SHRT_MAX)`
- This is due to my environment's install locations for the C include libraries: - This is due to my environment's install locations for the C include libraries:
- **Inside `buffer.h`, change the `#include` statement from `mm_malloc.h` to `malloc.h`, depending on what your compiler uses. Homebrew gcc6 installs on macOS might need this, but Linux and Windows generally will use `malloc.h`** - **Inside `buffer.h`, there is a `#DEFINE` line for `MACOS_DEP`. If you are using a Linux system or Windows and your malloc.h is actually named malloc.h, you can leave `#undef MACOS_DEP` alone, otherwise comment it out.**