Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gogovega/libft
My own library (LIBFT) of 42 Cursus containing basic and personal functions as well as Doxygen documentation and unit tests.
https://github.com/gogovega/libft
42 42-school campus19 documentation doxygen-documentation ftprintf getnextline gnl libft
Last synced: 6 days ago
JSON representation
My own library (LIBFT) of 42 Cursus containing basic and personal functions as well as Doxygen documentation and unit tests.
- Host: GitHub
- URL: https://github.com/gogovega/libft
- Owner: GogoVega
- License: mit
- Created: 2024-05-01T15:30:17.000Z (8 months ago)
- Default Branch: master
- Last Pushed: 2024-05-20T11:55:59.000Z (8 months ago)
- Last Synced: 2024-05-20T12:56:11.999Z (8 months ago)
- Topics: 42, 42-school, campus19, documentation, doxygen-documentation, ftprintf, getnextline, gnl, libft
- Language: C
- Homepage:
- Size: 77.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# LIBFT
Libft is the Library of 42 School which contains a number of standard C library
functions that need to be recoded, including adding additional functions that
can be used later in our projects. This library aims to understand how basic
functions work, implement them, and learn how to use them.
## Purpose
Coming Soon...
## How to Use?
To use this library, follow these steps:
1. Clone the repository to your local machine:
```bash
git clone https://github.com/GogoVega/LIBFT.git LIBFT
```
2. Navigate to the library directory:
```bash
cd LIBFT
```
3. Compile the library:
```bash
make
```
4. Include the library header file in your code:
```c
#include "libft.h"
```
5. Compile the library with your project:
```bash
gcc -Wall -Wextra -Werror libft.a your_file.c
```
## How to Test?
To test this library, you can run the following command:
```bash
make test
```
Coming Soon
## Feature
- Contains [Doxygen Documentation](https://marketplace.visualstudio.com/items?itemName=cschlosser.doxdocgen)
- Contains Unit Tests
## Getting Started Link
- [42 School](https://42.fr/en/homepage)
- [Francinette](https://github.com/xicodomingues/francinette)
## Contributing
All contributions are Welcome. Don't forget to include your test files if possible.
This repository adheres to the [Contributor Covenant 2.0](./CODE_OF_CONDUCT.md).
By participating, you are expected to uphold this code.
## Acknowledgment
- [Francinette](https://github.com/xicodomingues/francinette): to test our projects
- [Tripouille](https://github.com/Tripouille): for these tests for which I based myself for mine
## License
MIT License
Copyright (c) 2024 Gauthier Dandele
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.