diff --git a/README.md b/README.md index f4d8c29de..47260e11f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@
C++ Faker, a powerful tool for generating realistic and randomized fake data in C++ programming, enhancing data testing and development workflows

Faker C++

-

Generate fake (but realistic) data for testing and development.

+

The function of Faker C++ is to generate fake (but realistic) data for testing and development

[![clang++](https://github.com/cieslarmichal/faker-cxx/actions/workflows/linux-clang-build.yml/badge.svg?branch=main)](https://github.com/cieslarmichal/faker-cxx/actions/workflows/linux-clang-build.yml?query=branch%3Amain) [![apple clang++](https://github.com/cieslarmichal/faker-cxx/actions/workflows/macos-clang-build.yml/badge.svg?branch=main)](https://github.com/cieslarmichal/faker-cxx/actions/workflows/macos-clang-build.yml?query=branch%3Amain) @@ -14,13 +14,20 @@ ## ๐ŸŽฏ Goal -Goal of the Faker C++ is to provide a library like [Faker.js](https://github.com/faker-js/faker) for C++ community. +The goal of Faker C++ is to provide a library similar to [Faker.js](https://github.com/faker-js/faker) for C++ community. Faker C++ is a powerful library designed to streamline the creation of realistic and customizable fake data for testing and development purposes within C++ applications for all developers to use. The use of this library will provide a quick and user-friendly experience for developers, offering a wide variety of modules that cover everything from generating random names and addresses to crafting realistic financial and internet related data. By using Faker C++, developers can efficiently supply their applications with authentic-looking test data, facilitating an effective and accurate testing and development process. -## Usage +## Usage and Documentation + +To properly use Faker C++ you must first assimilate the Faker library (see Consuming Library with CMake). +Once that is done, you need to include the proper header files depending on the module you wish to generate data from. The module header file names can be found by looking in the directory include/faker-cxx. A list of the functions, their descriptions, and how to use them can be found here --> https://cieslarmichal.github.io/faker-cxx/ +Make sure to include the proper header file that corresponds to the data and subsequent functions you are trying to generate. + +Below is an example of how to implement Faker C++ in your code. ```cpp #include +//Include statements for the header files. #include "faker-cxx/Date.h" #include "faker-cxx/Internet.h" #include "faker-cxx/Location.h" @@ -28,25 +35,23 @@ Goal of the Faker C++ is to provide a library like [Faker.js](https://github.com int main() { + //variable declarations and function calls. const auto id = faker::String::uuid(); const auto email = faker::Internet::email(); const auto password = faker::Internet::password(); - const auto verificationCode = faker::String::numeric(8); - const auto createdAt = faker::Date::pastDate(); const auto city = faker::Location::city(); const auto streetAddress = faker::Location::streetAddress(); std::cout << id << std::endl; // 58018063-ce5a-4fa7-adfd-327eb2e2d9a5 std::cout << email << std::endl; // Lois_Hauck@hotmail.com std::cout << password << std::endl; // @cWLwgM#Knalxeb - std::cout << verificationCode << std::endl; // 31457428 - std::cout << createdAt << std::endl; // 2023-06-20T02:06:36Z std::cout << city << std::endl; // Sayreville std::cout << streetAddress << std::endl; // 1716 Harriet Alley return 0; } ``` +This example generates basic personal information including id, email, password, city, and street address. Users can tailor their data generation by exploring other modules and functions within the library. ## ๐Ÿ’Ž Modules @@ -82,10 +87,6 @@ int main() - ๐ŸŒค๏ธ Weather - temperature, pressure, humidity, weather description - ๐Ÿ’ฌ Word - sample words, nouns, verbs -## ๐Ÿ“– Documentation - -https://cieslarmichal.github.io/faker-cxx/ - ## Consuming library with CMake (CMake 3.22 or newer) 1. Add faker to git submodules (execute in project root): @@ -110,11 +111,20 @@ https://cieslarmichal.github.io/faker-cxx/ ## Compiler support +Use one of these compilers when working with Faker C++. + - [MSVCโžš](https://en.wikipedia.org/wiki/Microsoft_Visual_Studio) version 143 or newer. - [GCCโžš](https://gcc.gnu.org/) version 13 or newer. - [Clangโžš](https://clang.llvm.org/) version 16 or newer. - [Apple Clangโžš](https://clang.llvm.org/) version 16 or newer. +If you have any confusion please refer to the respective guides. + +- [Clang++](./docs/guides/clang-compilation-guide.md) +- [Apple Clang++](./docs/guides/apple-clang-compilation-guide.md) +- [G++](./docs/guides/gcc-compilation-guide.md) +- [MSVC](./docs/guides/msvc-compilation-guide.md) + ## Dependencies - GTest (```BUILD_FAKER_TESTS=OFF``` CMake flag to disable) @@ -122,15 +132,8 @@ https://cieslarmichal.github.io/faker-cxx/ ## โœจ Contributing -Feel free to join Faker C++ development! ๐Ÿš€ - -Please check [CONTRIBUTING](https://github.com/cieslarmichal/faker-cxx/blob/main/CONTRIBUTING.md) guide. - -[Discord Channel](https://discord.gg/h2ur8H6mK6) for contributors. +We would love it if you contributed to Faker C++! ๐Ÿš€ -## ๐Ÿ“ Compilation guides +Whether you are interested in fixing bugs, implementing new features, or improving documentation, your input is welcome and valuable. Before contributing, please review our [CONTRIBUTING](https://github.com/cieslarmichal/faker-cxx/blob/main/CONTRIBUTING.md) guide for guidelines on coding standards, making changes, and creating Pull Requests (PRs). Your engagement helps maintain the project's vitality and ensures Faker C++ remains a useful tool for the C++ community. -- [Clang++](./docs/guides/clang-compilation-guide.md) -- [Apple Clang++](./docs/guides/apple-clang-compilation-guide.md) -- [G++](./docs/guides/gcc-compilation-guide.md) -- [MSVC](./docs/guides/msvc-compilation-guide.md) +Additionally, we encourage you to join our [Discord Channel](https://discord.gg/h2ur8H6mK6) for contributors, where you can engage in discussions, seek assistance, and collaborate with fellow developers. Your contributions play a crucial role in the development and furthering of Faker C++. We look forward to your involvement and appreciate your commitment to the project's growth!