https://github.com/f-corvaro/my_static_c_library

Static C library for 42 projects.
https://github.com/f-corvaro/my_static_c_library

c doxygen ftprintf getnextline libft libftprintf staticlibrary utilities

Last synced: 3 months ago
JSON representation

Static C library for 42 projects.

Host: GitHub
URL: https://github.com/f-corvaro/my_static_c_library
Owner: f-corvaro
License: mit
Created: 2023-11-20T09:05:37.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-07-27T17:18:11.000Z (11 months ago)
Last Synced: 2024-07-27T18:41:55.200Z (11 months ago)
Topics: c, doxygen, ftprintf, getnextline, libft, libftprintf, staticlibrary, utilities
Language: C
Homepage: https://github.com/f-corvaro
Size: 1.53 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

Index

Library Overview

Running tests and features

Folder Structure and Compilation

Support and Contributions

Author

## Library Overview

This static library includes the following 42 projects: `get_next_line` (bonus functions only), `ft_printf` (with all format bonuses), and `libft` (with bonus functions). Additionally, custom boolean types and other useful utilities are defined within the code. Each function is documented with Doxygen-style comments for clarity.

To see the available commands for this library, navigate to the library path in the terminal and run:
```sh
make help
```

## Running tests and features

## Folder Structure and Compilation

The folder structure is straightforward, and the Makefile is designed for repeatable and easily implemented rules.

- All source files are stored in the `srcs` folder.
- The header files are stored in the `include` folder.
- The compiled library (`library.a`) is stored in the `build` folder.
- The object files (`files.o`) are stored in the `objs` folder.

The `build` and `objs` folders, along with their contents, are created only after compiling.

```
.
├─ lib
├── include
│ └── ft_printf.h
├── libft
│ ├── include
│ │ └── libft.h
│ ├── srcs
│ │ ├── ft_atoi.c
│ │ ├── ft_bzero.c
│ │ ├── ft_calloc.c
│ │ ├── ft_isalnum.c
│ │ ├── ft_isalpha.c
│ │ ├── ft_isascii.c
│ │ ├── ft_isdigit.c
│ │ ├── ft_isprint.c
│ │ ├── ft_itoa.c
│ │ ├── ft_lstadd_back.c
│ │ ├── ft_lstadd_front.c
│ │ ├── ft_lstclear.c
│ │ ├── ft_lstdelone.c
│ │ ├── ft_lstiter.c
│ │ ├── ft_lstlast.c
│ │ ├── ft_lstmap.c
│ │ ├── ft_lstnew.c
│ │ ├── ft_lstsize.c
│ │ ├── ft_memchr.c
│ │ ├── ft_memcmp.c
│ │ ├── ft_memcpy.c
│ │ ├── ft_memmove.c
│ │ ├── ft_memset.c
│ │ ├── ft_putchar_fd.c
│ │ ├── ft_putendl_fd.c
│ │ ├── ft_putnbr_fd.c
│ │ ├── ft_putstr_fd.c
│ │ ├── ft_split.c
│ │ ├── ft_strchr.c
│ │ ├── ft_strdup.c
│ │ ├── ft_striteri.c
│ │ ├── ft_strjoin.c
│ │ ├── ft_strlcat.c
│ │ ├── ft_strlcpy.c
│ │ ├── ft_strlen.c
│ │ ├── ft_strmapi.c
│ │ ├── ft_strncmp.c
│ │ ├── ft_strnstr.c
│ │ ├── ft_strrchr.c
│ │ ├── ft_strtrim.c
│ │ ├── ft_substr.c
│ │ ├── ft_tolower.c
│ │ ├── ft_toupper.c
│ │ ├── get_next_line_bonus.c
│ │ └── get_next_line_utils_bonus.c
│ └── Makefile
├── srcs
│ ├── ft_format.c
│ ├── ft_parse_and_handle_funcs.c
│ ├── ft_printf_funcs.c
│ ├── ft_printf.c
│ ├── ft_ptr.c
│ └── ft_utility_funcs.c
└── Makefile
```