diff --git a/.gitignore b/.gitignore index 88f129f..163c6f2 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,5 @@ dist __pycache__ .pytest_cache -*.pyc \ No newline at end of file +*.pyc +.DS_Store \ No newline at end of file diff --git a/LICENCE.md b/LICENCE.md index e060e5f..3c3fd37 100644 --- a/LICENCE.md +++ b/LICENCE.md @@ -1,3 +1,5 @@ +MIT LICENSE + Copyright 2024 Raphaël MANSUY 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: diff --git a/README.md b/README.md index 6d0f7c1..4a5ae5b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Code2Prompt is a powerful command-line tool that simplifies the process of provi With Code2Prompt, you can easily create a well-structured and informative document that serves as a valuable resource for feeding questions to LLMs, enabling them to better understand and assist with your code-related queries. +![Illustration](./docs/code2Prompt.jpg) + ## Features - Automatically traverses a directory and its subdirectories to include all relevant files @@ -140,7 +142,7 @@ To build a distributable package of Code2Prompt using Poetry, follow these steps ## License -Code2Prompt is released under the MIT License. See [LICENSE](LICENSE) for more information. +Code2Prompt is released under the MIT License. See [LICENSE](LICENSE.md) for more information. ## Contributing diff --git a/docs/code2Prompt.jpg b/docs/code2Prompt.jpg new file mode 100644 index 0000000..045e832 Binary files /dev/null and b/docs/code2Prompt.jpg differ