https://github.com/uddin-a/libft
Libft - the Clib for 42
https://github.com/uddin-a/libft
Last synced: 3 months ago
JSON representation
Libft - the Clib for 42
- Host: GitHub
- URL: https://github.com/uddin-a/libft
- Owner: uddin-a
- Created: 2017-06-27T10:43:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2020-01-12T22:47:18.000Z (over 5 years ago)
- Last Synced: 2025-01-05T17:31:16.332Z (5 months ago)
- Language: C
- Size: 688 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
**Libft** is a [42](https://en.wikipedia.org/wiki/42_(school)) project. The goal of this project is to create a [static library](https://en.wikipedia.org/wiki/Static_library) (c library) that will be used during the [42](https://en.wikipedia.org/wiki/42_(school)) course. **Libft** is meant to be similar to [libc](https://en.wikipedia.org/wiki/C_standard_library) library, where many different type of function are included to help with other `projects`. To know more about `libft` **`api`** refer to the [wiki](https://github.com/suddin0/libft/wiki) section.
## Build the library
**Libft** is a static `C` library. A [`makefile`](https://fr.wikipedia.org/wiki/GNU_Make) is included to build the project. The follwing recipe can be used:
|recipe | Description|
|--------|-----------|
|all| Creates the library |
|clean| Remove all generated [object](https://en.wikipedia.org/wiki/Object_file) files|
|fclean| Calls the `clean` recipe and remove the [library]() file|
|re | Calls the `fclean` recipe and `all` recipe (recompile the library|
Once the compilation is finished a file called `libft.a` will be created in the directory `lib`
## Header files.
Current version of `libft` contains function from following libraries and each of them has their own header (`.h`) files:
|Library name| header file| status|
|--------------|-----|------------|
|`libft`| **libft.h**| finished |
|[printf](https://en.wikipedia.org/wiki/Printf_format_string)| **ft_printf.h**| finished|
|[getopt](https://en.wikipedia.org/wiki/Getopt)| **ft_getopt.h** | unfinished |
|`string` (not the standard ***strings.h***)|**ft_string.h** | unfinished|
## Including `libft` to a project
The library (`.a`) file is created in **`lib/`** directory and the header (`.h`) files can be found in the `include/` directory.
Assuming you have cloned the project (libft) to the root directory of your project. To use the libft on the project you would use as following
```bash
## before you do the following you must create the `libft.a`
## file in the libft project
cc -I libft/include -L libft/lib -lft -o
```
## More information.
### For more information about about all the libraries and their api refer to the [wiki](https://github.com/suddin0/libft/wiki) section.